コレクションは、マーケターが事前に定義した条件(オファーのカテゴリなど)に基づくオファーのサブセットです。
リクエストパスにコレクション id
を含む GET リクエストを Offer Library API に対して実行することで、特定のコレクションを検索できます。
API 形式
GET /{ENDPOINT_PATH}/offer-collections/{ID}
パラメーター | 説明 | 例 |
---|---|---|
{ENDPOINT_PATH} |
永続性 API のエンドポイントパス。 | https://platform.adobe.io/data/core/dps/ |
{ID} |
検索するエンティティの ID。 | offerCollection1234 |
リクエスト
curl -X GET 'https://platform.adobe.io/data/core/dps/offer-collections/offerCollection1234' \
-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}'
応答
正常な応答の場合は、一意のコレクション id
に関する情報など、コレクションの詳細が返されます。
{
"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"
]
}