コレクションのリスト list-collections

Last update: Thu Dec 18 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

適用対象：
Journey Orchestration

作成対象：

経験者
開発者

TIP

Adobe Journey Optimizer の新しい決定機能である決定が、コードベースのエクスペリエンスチャネルとメールチャネルを通じて使用できるようになりました。詳細情報

コレクションは、マーケターが事前に定義した条件（オファーのカテゴリなど）に基づくオファーのサブセットです。

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