배치는 오퍼를 표시하는 데 사용되는 컨테이너입니다. 배치는 메시지 내의 올바른 위치에 올바른 오퍼 컨텐츠가 표시되도록 하는 데 도움이 됩니다. 오퍼에 컨텐츠를 추가할 때 해당 컨텐츠가 표시될 수 있는 배치를 선택하라는 메시지가 표시됩니다.
에 대한 단일 GET 요청을 수행하여 컨테이너 내의 모든 배치 목록을 볼 수 있습니다 Offer Library API.
API 형식
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_PLACEMENT}&{QUERY_PARAMS}
매개 변수 | 설명 | 예 |
---|---|---|
{ENDPOINT_PATH} |
저장소 API의 끝점 경로입니다. | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
배치가 있는 컨테이너입니다. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
SCHEMA_PLACEMENT} |
배치와 연관된 스키마를 정의합니다. | https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4 |
{QUERY_PARAMS} |
결과를 기준으로 필터링할 선택적 쿼리 매개 변수입니다. | limit=2 |
리소스를 나열할 때 쿼리 매개 변수를 사용하여 결과를 페이지 및 필터링할 수 있습니다.
페이징의 가장 일반적인 쿼리 매개 변수는 다음과 같습니다.
매개 변수 | 설명 | 예 |
---|---|---|
q |
선택한 필드에서 검색할 선택적 쿼리 문자열입니다. 쿼리 문자열은 소문자여야 하며 큰따옴표로 묶어서 토큰화되지 않도록 하고 특수 문자를 이스케이프 처리할 수 있습니다. 문자 `+ - = && | |
qop |
q 쿼리 문자열 매개 변수의 값에 AND 또는 OR 연산자를 적용합니다. | AND / OR |
field |
검색을 다음으로 제한할 필드 선택 사항입니다. 이 매개 변수는 다음과 같이 반복할 수 있습니다. field=field1[,field=field2,…] 및 (경로 표현식은 _instance.xdm:name과 같이 점으로 구분된 경로의 형식입니다.) | _instance.xdm:name |
orderBy |
특정 속성별로 결과를 정렬합니다. 추가 - 이전 제목 (orderby=-title )은 제목별로 항목을 내림차순으로 정렬합니다(Z-A). |
-repo:createdDate |
limit |
반환된 배치 수를 제한합니다. | limit=5 |
요청
curl -X GET \
'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4&limit=2' \
-H 'Accept: *,application/json' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
응답
성공적인 응답은 액세스 권한이 있는 컨테이너 내에 있는 배치 목록을 반환합니다.
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4",
"requestTime": "2020-10-21T19:48:51.843067Z",
"_embedded": {
"results": [
{
"instanceId": "0feb6a80-0f32-11eb-8110-e17787c335b5",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4"
],
"productContexts": [
"acp"
],
"repo:etag": 2,
"repo:createdDate": "2020-10-15T22:02:05.480449Z",
"repo:lastModifiedDate": "2020-10-15T22:13:00.278175Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:name": "New placement name",
"xdm:componentType": "https://ns.adobe.com/experience/offer-management/content-component-html",
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
"xdm:description": "Updated placement description",
"@id": "xcore:offer-placement:12466ef35fc5baa0"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4#0feb6a80-0f32-11eb-8110-e17787c335b5",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/0feb6a80-0f32-11eb-8110-e17787c335b5",
"@type": "https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4"
}
}
},
{
"instanceId": "269192b0-f8f2-11ea-8723-916b9fbadc53",
"schemas": [
"https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4"
],
"productContexts": [
"acp"
],
"repo:etag": 1,
"repo:createdDate": "2020-09-17T14:29:10.107121Z",
"repo:lastModifiedDate": "2020-09-17T14:29:10.107121Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:componentType": "https://ns.adobe.com/experience/offer-management/content-component-html",
"xdm:name": "demo placement",
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
"@id": "xcore:offer-placement:1221fac4e7340521"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4#269192b0-f8f2-11ea-8723-916b9fbadc53",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/269192b0-f8f2-11ea-8723-916b9fbadc53",
"@type": "https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 17,
"count": 2
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
},
"next": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?start=269192b0-f8f2-11ea-8723-916b9fbadc53&orderby=instanceId&schema=https://ns.adobe.com/experience/offer-management/offer-placement;version=0.4&limit=2",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}