Créer une sélection dans le catalogue
/catalogs/{catalog_name}/selections
Utilisez cet endpoint pour créer une sélection dans votre catalogue.
Cet endpoint est actuellement en accès anticipé. Contactez votre gestionnaire de satisfaction client si vous souhaitez participer à cet accès anticipé.
Conditions préalables
Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation catalogs.create_selection
.
Limite de débit
This endpoint has a shared rate limit of 50 requests per minute between all asynchronous catalog fields and selections endpoints, as documented in API rate limits.
Paramètres de chemin
Paramètre | Requis | Type de données | Description |
---|---|---|---|
catalog_name |
Requis | Chaîne de caractères | Nom du catalogue. |
Paramètres de demande
Paramètre | Requis | Type de données | Description |
---|---|---|---|
selection |
Requis | Objet | Un objet qui contient des critères de sélection. Les objets de sélection peuvent contenir name , description , filters , results_limit , sort_field , et sort_order . |
Exemple de demande
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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",
"filters": [
{
"field": "City",
"operator": "equals",
"value": "NYC"
},
{
"field": "Rating",
"operator": "greater than",
"value": 7
}
]
}
}'
Opérateurs de filtrage
Type de champ | Opérateurs pris en charge |
---|---|
string |
equals , does not equal |
number |
equals , does not equal , greater than , less than |
boolean |
is |
time |
before , after |
array |
includes value , does not include value |
Réponse
Trois réponses de code de statut existent pour cet endpoint : 202
, 400
et 404
.
Exemple de réponse réussie
Le code de statut 202
pourrait renvoyer le corps de réponse suivant.
1
2
3
{
"message": "success"
}
Exemple de réponse échouée
Le code de statut 400
pourrait renvoyer le corps de réponse suivant. Consultez la résolution des problèmes pour plus d’informations concernant les erreurs que vous pourriez rencontrer.
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"
}
Résolution des problèmes
Le tableau suivant répertorie les erreurs renvoyées possibles et les étapes de résolution des problèmes associées.
Erreur | Résolution des problèmes |
---|---|
catalog-not-found |
Vérifiez que le nom du catalogue est valide. |
company-size-limit-already-reached |
La limite de taille de stockage du catalogue est atteinte. |
selection-limit-reached |
La limite des sélections du catalogue est atteinte. |
invalid-selection |
Vérifiez que la sélection est valide. |
too-many-filters |
Vérifiez si la sélection comporte trop de filtres. |
selection-name-already-exists |
Vérifier si le nom de la sélection existe déjà dans le catalogue. |
selection-has-invalid-filter |
Vérifiez que le filtre de sélection est valide. |
selection-invalid-results-limit |
Vérifiez que la limite des résultats de la sélection est valide. |
invalid-sorting |
Vérifier si le tri de la sélection est valide. |
invalid-sort-field |
Vérifier si le champ de tri de la sélection est valide. |
invalid-sort-order |
Vérifier si l’ordre de tri de la sélection est valide. |
selection-contains-too-many-arrays |
Vérifiez si la sélection contient plus d’un champ de type array . Un seul est pris en charge. |