카탈로그 선택 항목 만들기
post
/catalogs/{catalog_name}/selections
이 엔드포인트를 사용하여 카탈로그에서 선택 항목을 생성합니다.
필수 조건
이 엔드포인트를 사용하려면 catalogs.create_selection 권한이 있는 API 키가 필요합니다.
사용량 제한
이 엔드포인트는 API 속도 제한 설명서에 명시된 바와 같이, 모든 비동기 카탈로그 필드 및 선택 엔드포인트 간에 분당 50개의 요청이라는 공유 속도 제한을 적용받습니다.
경로 매개변수
| 매개변수 | 필수 | 데이터 유형 | 설명 |
|---|---|---|---|
catalog_name |
Required | 문자열 | 카탈로그의 이름입니다. |
요청 매개변수
| 매개변수 | 필수 | 데이터 유형 | 설명 |
|---|---|---|---|
selection |
필수 | 객체 | 선택 기준이 포함된 개체입니다. 전체 개체 및 해당 필드에 대한 세부 사항은 catalog selection object을(를) 참조하십시오. |
선택 개체 매개변수
| 매개변수 | 필수 | 데이터 유형 | 설명 |
|---|---|---|---|
name |
Required | 문자열 | 카탈로그 선택의 이름입니다. |
description |
Optional | 문자열 | 카탈로그 선택에 대한 설명입니다. |
external_id |
Required | 문자열 | 선택을 위한 고유 식별자입니다. |
source |
Required | 문자열 | 카탈로그 데이터의 출처입니다. Shopify 카탈로그의 경우 "Shopify"을(를) 사용하십시오. 커스텀 카탈로그의 경우 "custom"을(를) 사용하십시오. |
filters |
선택 사항 | 배열 | 카탈로그 항목에 적용할 필터 개체의 배열입니다. 요청당 최대 네 개의 필터를 지정할 수 있습니다. 필터가 제공되지 않으면 카탈로그의 모든 항목이 포함됩니다. |
results_limit |
선택 사항 | 정수 | 반환할 최대 결과 수입니다. 1과 50 사이의 숫자여야 합니다. |
sort_field |
Optional | 문자열 | 결과를 정렬할 필드입니다. 이것은 sort_order과(와) 쌍을 이루어야 합니다. sort_field와 sort_order이 모두 없으면 결과가 무작위로 표시됩니다. |
sort_order |
Optional | 문자열 | 결과를 정렬하는 순서입니다. 허용되는 값은 "asc" (오름차순) 또는 "desc" (내림차순)입니다. 이것은 sort_field과(와) 쌍을 이루어야 합니다. sort_field와 sort_order가 모두 없으면 결과가 무작위로 표시됩니다. |
note:
sort_field 및 sort_order 매개변수는 함께 사용해야 합니다. 하나를 제공하고 다른 하나를 제공하지 않거나 두 매개변수를 모두 생략하면 선택 결과가 무작위 순서로 반환됩니다.
요청 예시
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": "custom",
"filters": [
{
"field": "City",
"operator": "equals",
"value": "NYC"
},
{
"field": "Rating",
"operator": "greater than",
"value": 7
}
],
"results_limit": 10,
"sort_field": "Rating",
"sort_order": "desc"
}
}'
필터 연산자
| 필드 유형 | 지원되는 사업자 |
|---|---|
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 |
note:
API는 선택 요청당 최대 네 개의 필터를 지원합니다. Braze 대시보드에서는 선택당 최대 10개의 필터를 추가할 수 있습니다. 필터는 배열에 나타나는 순서대로 적용됩니다.
Response
이 엔드포인트에 대한 상태 코드 응답은 202, 400, 404 의 세 가지가 있습니다 .
성공 응답의 예
202 상태 코드는 다음과 같은 응답 본문을 반환할 수 있습니다.
1
2
3
{
"message": "success"
}
오류 응답의 예
400 상태 코드는 다음과 같은 응답 본문을 반환할 수 있습니다. 발생할 수 있는 오류에 대한 자세한 내용은 문제 해결을 참조하세요.
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"
}
문제 해결
다음 표에는 가능한 반환 오류와 관련된 문제 해결 단계가 나와 있습니다.
| 오류 | 문제 해결 |
|---|---|
catalog-not-found |
카탈로그 이름이 유효한지 확인합니다. |
company-size-limit-already-reached |
카탈로그 저장소 크기 제한에 도달했습니다. |
selection-limit-reached |
카탈로그 선택 제한에 도달했습니다. |
invalid-selection |
선택 항목이 유효한지 확인합니다. |
too-many-filters |
선택 항목에 필터가 너무 많은지 확인합니다. |
selection-name-already-exists |
선택 이름이 카탈로그에 이미 있는지 확인합니다. |
selection-has-invalid-filter |
선택 필터가 유효한지 확인합니다. |
selection-invalid-results-limit |
선택 결과 제한이 유효한지 확인합니다. |
invalid-sorting |
선택 정렬이 유효한지 확인합니다. |
invalid-sort-field |
선택 정렬 필드가 유효한지 확인합니다. |
invalid-sort-order |
선택 정렬 순서가 올바른지 확인합니다. |
selection-contains-too-many-arrays |
선택 항목에 array 유형이 있는 필드가 두 개 이상 포함되어 있는지 확인합니다. 하나만 지원됩니다. |
New Stuff!
GitHub 에서 이 페이지를 편집합니다.