Objet de sélection du catalogue
Lors de la création d’une sélection de catalogue, vous pouvez fournir un objet de sélection afin de définir les critères de filtrage, de tri et de limitation pour les éléments renvoyés par votre catalogue.
Cetselectionobjet vous permet de spécifier quels éléments de votre catalogue doivent être inclus dans la sélection en fonction de filtres, comment ils doivent être triés et combien de résultats doivent être renvoyés. Veuillez utiliser cet objet lors de la création de sélections de catalogue via l’API.
Corps de l’objet
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"selection": {
"name": "Sale",
"description": "Sales Collection",
"external_id": "12345678",
"source": "Shopify",
"filters": [
{
"field": "collection",
"operator": "includes value",
"value": "Best Seller"
},
{
"field": "collection",
"operator": "does not include value",
"value": "Sale"
}
],
"results_limit": 5,
"sort_field": "id",
"sort_order": "asc"
}
}
Détails de l’objet
| Clé | Requis | Type de données | Description |
|---|---|---|---|
name |
Requis | Chaîne de caractères | Le nom de la sélection du catalogue. |
description |
Facultatif | Chaîne de caractères | Une description de la sélection du catalogue. |
external_id |
Requis | Chaîne de caractères | Identifiant unique pour la sélection. |
source |
Requis | Chaîne de caractères | La source des données du catalogue. Pour les catalogues Shopify, veuillez définir cette option sur "Shopify". Pour les catalogues non Shopify, veuillez utiliser une chaîne de caractères descriptive telle que"custom"ou le nom de votre intégration. |
filters |
Facultatif | Tableau d’objets | Un ensemble d’objets filtres à appliquer aux éléments du catalogue. Vous pouvez définir jusqu’à quatre filtres par requête. Si aucun filtre n’est spécifié, tous les articles du catalogue sont inclus. |
results_limit |
Facultatif | Entier | Le nombre maximal de résultats à renvoyer. Il est nécessaire d’indiquer un nombre compris entre 1 et 50. |
sort_field |
Facultatif | Chaîne de caractères | Le champ selon lequel trier les résultats. Il est nécessaire de l’associer à sort_order. Si nisort_fieldl’un ni l’autre nesort_order sont présents, les résultats sont renvoyés dans un ordre aléatoire. |
sort_order |
Facultatif | Chaîne de caractères | L’ordre de tri des résultats. Les valeurs acceptées sont"asc"(ascendant) ou"desc"(descendant). Il est nécessaire de l’associer à sort_field. Si nisort_fieldl’un ni l’autre nesort_order sont présents, les résultats sont renvoyés dans un ordre aléatoire. |
Objet filtre
Chaque objet filtre dufilterstableau d’objets contient les champs décrits dans le tableau suivant.
| Clé | Requis | Type de données | Description |
|---|---|---|---|
field |
Requis | Chaîne de caractères | Le champ du catalogue sur lequel appliquer le filtre. |
operator |
Requis | Chaîne de caractères | L’opérateur de comparaison à utiliser pour le filtrage. Par exemple, veuillez considérer"includes value"et"does not include value". |
value |
Requis | Variable (chaîne de caractères, nombre, booléen, heure) | La valeur à comparer. Ceci doit correspondre au type de données du champ du catalogue sous-jacent (par exemple, chaîne de caractères, nombre, booléen, heure). |
L’API prend en charge un maximum de quatre filtres par requête de sélection. Dans le tableau de bord de Braze, il est possible d’ajouter jusqu’à 10 filtres par sélection. Les filtres sont appliqués dans l’ordre dans lequel ils apparaissent dans le tableau.
Modifier cette page sur GitHub