개인화된 오퍼 나열 list-personalized-offers
맞춤형 오퍼는 자격 규칙 및 제한에 따라 사용자 정의 가능한 마케팅 메시지입니다.
Offer Library API에 대한 단일 GET 요청을 수행하여 컨테이너 내의 모든 개인화된 오퍼 목록을 볼 수 있습니다.
API 형식
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_PERSONALIZED_OFFER}&{QUERY_PARAMS}
매개변수
설명
예
{ENDPOINT_PATH}저장소 API의 끝점 경로입니다.
https://platform.adobe.io/data/core/xcore/{CONTAINER_ID}개인화된 오퍼가 있는 컨테이너입니다.
e0bd8463-0913-4ca1-bd84-6309134ca1f6{SCHEMA_PERSONALIZED_OFFER}개인화된 오퍼와 연결된 스키마를 정의합니다.
https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5{QUERY_PARAMS}결과를 필터링 기준으로 사용할 선택적 쿼리 매개 변수입니다.
limit=1요청
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/personalized-offer;version=0.5&limit=1' \
-H 'Accept: *,application/vnd.adobe.platform.xcore.hal+json; schema="https://ns.adobe.com/experience/xcore/hal/results"' \
-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}'
쿼리 매개 변수 사용 using-query-parameters
쿼리 매개 변수를 사용하여 리소스를 나열할 때 결과를 페이지로 지정하고 필터링할 수 있습니다.
페이징 paging
페이징에 가장 일반적인 쿼리 매개 변수는 다음과 같습니다.
매개변수
설명
예
q선택한 필드에서 검색할 선택적 쿼리 문자열입니다. 쿼리 문자열은 소문자여야 하며 토큰화되지 않고 특수 문자를 이스케이프 처리할 수 있도록 큰따옴표로 묶을 수 있습니다.
+ - = && || > < ! ( ) { } [ ] ^ \" ~ * ? : \ / 문자는 특별한 의미가 있으므로 쿼리 문자열에 표시할 때 백슬래시로 이스케이프해야 합니다.discounted offersqopq 쿼리 문자열 매개 변수의 값에 AND 또는 OR 연산자를 적용합니다.
AND / ORfield검색을 제한할 선택적 필드 목록입니다. 이 매개 변수는 다음과 같이 반복될 수 있습니다. field=field1[,field=field2,…] 및 (경로 표현식은 _instance.xdm:name과 같이 점으로 구분된 경로 형식입니다.)
_instance.xdm:nameorderBy특정 속성별로 결과를 정렬합니다. 제목(
-) 앞에 orderby=-title을(를) 추가하면 제목별로 내림차순(Z-A)으로 항목이 정렬됩니다.-repo:createdDatelimit반환되는 개인화된 오퍼의 수를 제한합니다.
limit=5응답
성공적인 응답은 액세스 권한이 있는 컨테이너 내에 있는 개인화된 오퍼 목록을 반환합니다.
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5",
"requestTime": "2023-10-22T20:36:50.408105Z",
"_embedded": {
"results": [
{
"instanceId": "2cdb4d10-149e-11eb-b1a9-a779d2fe8690",
"schemas": [
"https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 2,
"repo:createdDate": "2023-10-22T19:38:35.489354Z",
"repo:lastModifiedDate": "2023-10-22T19:45:43.839088Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:name": "Checking Advanced",
"xdm:representations": [
{
"xdm:components": [
{
"dc:format": "image/png",
"repo:id": "urn:aaid:sc:US:7db21be9-89ee-472a-b2c9-91f7a39ada51",
"repo:resolveURL": "https://platform-cs-va6.adobe.io/content/storage/id/urn:aaid:sc:US:7db21be9-89ee-472a-b2c9-91f7a39ada51/:rendition;size=300",
"repo:name": "mobile-check-deposit.png",
"dc:language": [
"en-us"
],
"@type": "https://ns.adobe.com/experience/offer-management/content-component-imagelink",
"xdm:deliveryURL": ""
}
],
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/offline",
"xdm:placement": "xcore:offer-placement:124f4e33724bb15f"
},
{
"xdm:components": [
{
"dc:format": "text/html",
"repo:name": "my content",
"dc:language": [
"en-us"
],
"xdm:content": "{\n\"foo\": \"bar\"\n}",
"@type": "https://ns.adobe.com/experience/offer-management/content-component-html"
}
],
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
"xdm:placement": "xcore:offer-placement:124e0be5699743d3"
}
],
"xdm:rank": {
"xdm:priority": 10
},
"xdm:characteristics": {
"PROD": "checking",
"offer_code": "CHECK200",
"region": "NA"
},
"xdm:selectionConstraint": {
"xdm:startDate": "2023-10-22T07:00:00.000Z",
"xdm:endDate": "2023-12-31T08:00:00.000Z",
"xdm:eligibilityRule": "xcore:eligibility-rule:124f4f57259caba5"
},
"xdm:status": "draft",
"xdm:cappingConstraint": {
"xdm:globalCap": 1000
},
"xdm:tags": [
"xcore:tag:124f4e5c8a00cd92",
"xcore:tag:1229cf47455177b1"
],
"@id": "xcore:personalized-offer:124f513c290bb16e"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5#2cdb4d10-149e-11eb-b1a9-a779d2fe8690",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/2cdb4d10-149e-11eb-b1a9-a779d2fe8690",
"@type": "https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 15,
"count": 1
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5&orderby=-repo:createdDate&limit=1",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
},
"next": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?start=1603395515489%2C2cdb4d10-149e-11eb-b1a9-a779d2fe8690&schema=https://ns.adobe.com/experience/offer-management/personalized-offer;version=0.5&orderby=-repo%3AcreatedDate%2CinstanceId&limit=1",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76