コレクション修飾子のリスト list-tags

コレクション修飾子(旧称「タグ」)を使用すると、オファーをより適切に整理し並べ替えることができます。例えば、ブラックフライデーのオファーに「ブラックフライデー」コレクション修飾子のラベルを付けることができます。オファーライブラリの検索機能を使用すると、そのコレクション修飾子を持つすべてのオファーを簡単に見つけることができます。

また、コレクション修飾子を使用して、オファーをコレクションにグループ化することもできます。

Offer Library API に対して単一の GET リクエストを実行することで、コンテナ内のすべてのコレクション修飾子のリストを表示できます。

API 形式

GET /{ENDPOINT_PATH}/tags?{QUERY_PARAMS}
パラメーター
説明
{ENDPOINT_PATH}
永続性 API のエンドポイントパス。
https://platform.adobe.io/data/core/dps
{QUERY_PARAMS}
結果をフィルタリングする条件となるクエリパラメーター(オプション)。
limit=2

ページング 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

リクエスト

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

応答

正常な応答では、アクセス可能なコンテナ内に存在するコレクション修飾子のリストが返されます。

{
    "results": [
        {
            "created": "2022-09-16T19:00:02.070+00:00",
            "modified": "2022-09-16T19:00:02.070+00:00",
            "etag": 1,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/tag;version=0.1"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "tag1234",
            "name": "Sneakers"
        },
        {
            "created": "2022-09-16T19:55:02.168+00:00",
            "modified": "2022-09-16T19:55:02.168+00:00",
            "etag": 1,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/tag;version=0.1"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "tag5678",
            "name": "Black Friday"
        }
    ],
    "count": 2,
    "total": 5,
    "_links": {
        "self": {
            "href": "/tags?href={SELF_HREF}&limit=2",
            "type": "application/json"
        },
        "next": {
            "href": "/tags?href={NEXT_HREF}&limit=2",
            "type": "application/json"
        }
    }
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76