설명서Journey OptimizerJourney Optimizer 안내서

컬렉션 나열 list-collections

Last update: Wed Jul 17 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

작성 대상:

  • 경험
  • 개발자

컬렉션은 오퍼의 카테고리와 같이 마케터가 정의한 사전 정의된 조건을 기반으로 하는 오퍼의 하위 집합입니다.

Offer Library API에 대한 단일 GET 요청을 수행하여 모든 컬렉션 목록을 볼 수 있습니다.

API 형식

GET /{ENDPOINT_PATH}/offer-collections?{QUERY_PARAMS}
매개변수
설명
예
{ENDPOINT_PATH}
지속성 API의 끝점 경로입니다.
https://platform.adobe.io/data/core/dps
{QUERY_PARAMS}
결과를 필터링 기준으로 사용할 선택적 쿼리 매개 변수입니다.
limit=2

요청

curl -X GET 'https://platform.adobe.io/data/core/dps/offer-collections?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}'

쿼리 매개 변수 사용 using-query-parameters

쿼리 매개 변수를 사용하여 리소스를 나열할 때 결과를 페이지로 지정하고 필터링할 수 있습니다.

페이징 paging

페이징에 가장 일반적인 쿼리 매개 변수는 다음과 같습니다.

매개변수
설명
예
property

선택적 속성 필터:

  • 속성은 AND 작업별로 그룹화됩니다.
  • 매개 변수는 다음과 같이 반복될 수 있습니다. property={PROPERTY_EXPR}[&property={PROPERTY_EXPR2}…] 또는 property={PROPERTY_EXPR1}[,{PROPERTY_EXPR2}…]
  • 속성 표현식이 [ !]field[op]value 형식이며 [==,!=,<=,>=,<,>,~]에 op이(가) 있어 정규 표현식을 지원합니다.
property=name!=abc&property=id~.*1234.*&property=description equivalent with property=name!=abc,id~.*1234.*,description.
orderBy
특정 속성별로 결과를 정렬합니다. 이름 앞에 - 를 추가하면 (orderby=-name) 내림차순 (Z-A)으로 이름별로 항목이 정렬됩니다. 경로 표현식은 점으로 구분된 경로 형식입니다. 이 매개 변수는 다음과 같이 반복될 수 있습니다. orderby=field1[,-fields2,field3,...]
orderby=id,-name
limit
반환되는 엔티티 수를 제한합니다.
limit=5

응답

성공적인 응답은 액세스 권한이 있는 컨테이너 내에 있는 컬렉션 목록을 반환합니다.

{
    "results": [
        {
            "created": "2022-09-16T18:59:23.063+00:00",
            "modified": "2022-09-16T18:59:23.063+00:00",
            "etag": 1,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.4"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "offerCollection1234",
            "name": "Test Collection with tags",
            "filterType": "any-tags",
            "ids": [
                "tag1234"
            ],
            "labels": [
                "core/C5",
                "custom/myLabel"
            ]
        },
        {
            "created": "2023-05-15T12:50:49.887+00:00",
            "modified": "2023-05-15T12:50:49.887+00:00",
            "etag": 1,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/offer-filter;version=0.4"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "offerCollection5678",
            "name": "Test Collection with offers",
            "filterType": "offers",
            "ids": [
                "personalizedOffer1234",
                "personalizedOffer5678"
            ]
        }
    ],
    "count": 2,
    "total": 9,
    "_links": {
        "self": {
            "href": "/offer-collections?href={SELF_HREF}&limit=2",
            "type": "application/json"
        },
        "next": {
            "href": "/offer-collections?href={NEXT_HREF}&limit=2",
            "type": "application/json"
        }
    }
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76