Katalogauswahl erstellen

Verwenden Sie diesen Endpunkt, um eine Auswahl in Ihrem Katalog zu erstellen.

Voraussetzungen

Um diesen Endpunkt zu verwenden, benötigen Sie einen API-Schlüssel mit der Berechtigung catalogs.create_selection.

Rate-Limit

Für diesen Endpunkt gilt ein gemeinsames Rate-Limit von 50 Anfragen pro Minute für alle asynchronen Katalogfelder- und Auswahl-Endpunkte, wie in API-Rate-Limits dokumentiert.

Pfad-Parameter

Anfrage-Parameter

Parameter des Auswahlobjekts

Hinweis

Die Parameter sort_field und sort_order müssen zusammen verwendet werden. Wenn Sie nur einen der beiden Parameter angeben oder beide Parameter weglassen, werden die Auswahlergebnisse in zufälliger Reihenfolge zurückgegeben.

Beispielanfrage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
curl --location --request POST 'https://rest.iad-03.braze.com/catalogs/restaurants/selections' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
  "selection": {
    "name": "favorite-restaurants",
    "description": "Favorite restaurants in NYC",
    "external_id": "favorite-nyc-restaurants",
    "source": "Braze",
    "filters": [
      {
        "field": "City",
        "operator": "equals",
        "value": "NYC"
      },
      {
        "field": "Rating",
        "operator": "greater than",
        "value": 7
      }
    ],
    "results_limit": 10,
    "sort_field": "Rating",
    "sort_order": "desc"
  }
}'

Filteroperatoren

Hinweis

Die API unterstützt maximal zehn Filter pro Auswahlanfrage. Filter werden in der Reihenfolge angewendet, in der sie im Array erscheinen.

Hinweis

Wenn Sie einen geo-Filter anwenden, sortiert das System die Ergebnisse automatisch nach Entfernung, wobei das nächstgelegene Element zuerst angezeigt wird – unabhängig von den Parametern sort_field und sort_order.

Antwort

Es gibt drei Statuscode-Antworten für diesen Endpunkt: 202, 400 und 404.

Beispiel für eine erfolgreiche Antwort

Der Statuscode 202 könnte den folgenden Antwortkörper zurückgeben.

1
2
3
{
  "message": "success"
}

Beispiel für eine Fehlerantwort

Der Statuscode 400 könnte den folgenden Antwortkörper zurückgeben. Unter Fehlerbehebung finden Sie weitere Informationen zu Fehlern, die auftreten können.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "errors": [
    {
      "id": "catalog-not-found",
      "message": "Could not find catalog",
      "parameters": [
        "catalog_name"
      ],
      "parameter_values": [
        "restaurants"
      ]
    }
  ],
  "message": "Invalid Request"
}

Fehlerbehebung

In der folgenden Tabelle finden Sie mögliche zurückgegebene Fehler und die entsprechenden Schritte zur Fehlerbehebung.