Crear selección de catálogo
post
/catalogs/{catalog_name}/selections
Utiliza este punto final para crear una selección en tu catálogo.
Requisitos previos
Para utilizar este punto final, necesitarás una clave de API con el permiso catalogs.create_selection
.
Límite de velocidad
Parámetros de la ruta
Parámetro | Obligatoria | Tipo de datos | Descripción |
---|---|---|---|
catalog_name |
Obligatoria | Cadena | Nombre del catálogo. |
Parámetros de la solicitud
Parámetro | Obligatoria | Tipo de datos | Descripción |
---|---|---|---|
selection |
Obligatoria | Objeto | Un objeto que contiene criterios de selección. Los objetos de selección pueden contener name , description , filters , results_limit , sort_field y sort_order . |
Ejemplo de solicitud
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
}
]
}
}'
Operadores de filtrado
Tipo de campo | Operadores admitidos |
---|---|
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 |
Respuesta
Existen tres respuestas de código de estado para este punto final: 202
, 400
y 404
.
Ejemplo de respuesta positiva
El código de estado 202
podría devolver el siguiente cuerpo de respuesta.
1
2
3
{
"message": "success"
}
Ejemplo de respuesta de error
El código de estado 400
podría devolver el siguiente cuerpo de respuesta. Consulte la sección Solución de problemas para obtener más información sobre los errores que puede encontrar.
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"
}
Solución de problemas
La siguiente tabla enumera los posibles errores devueltos y los pasos asociados para solucionarlos.
Error | Solución de problemas |
---|---|
catalog-not-found |
Compruebe que el nombre del catálogo es válido. |
company-size-limit-already-reached |
Se ha alcanzado el límite de tamaño de almacenamiento del catálogo. |
selection-limit-reached |
Se ha alcanzado el límite de selecciones del catálogo. |
invalid-selection |
Comprueba que la selección es válida. |
too-many-filters |
Comprueba si la selección tiene demasiados filtros. |
selection-name-already-exists |
Comprueba si el nombre de la selección ya existe en el catálogo. |
selection-has-invalid-filter |
Comprueba si el filtro de selección es válido. |
selection-invalid-results-limit |
Comprueba si el límite de resultados de la selección es válido. |
invalid-sorting |
Comprueba si la ordenación de la selección es válida. |
invalid-sort-field |
Comprueba si el campo de ordenación de la selección es válido. |
invalid-sort-order |
Comprueba si el orden de clasificación de la selección es válido. |
selection-contains-too-many-arrays |
Comprueba si la selección contiene más de un campo con el tipo array . Solo se admite uno. |
New Stuff!