Lista samlingar list-collections

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

Gäller:
Journey Orchestration

Skapat för:

Erfaren
Utvecklare

TIP

Beslutsfattandet, Adobe Journey Optimizers nya beslutsfunktion, är nu tillgängligt via den kodbaserade upplevelsen och e-postkanalerna! Läs mer

Samlingar är delmängder av erbjudanden som baseras på fördefinierade villkor som definieras av en marknadsförare, t.ex. erbjudandets kategori.

Du kan visa en lista över alla samlingar genom att utföra en enda GET-begäran till API:t Offer Library.

API-format

GET /{ENDPOINT_PATH}/offer-collections?{QUERY_PARAMS}

Parameter

Beskrivning

Exempel

{ENDPOINT_PATH}

Slutpunktssökvägen för beständiga API:er.

https://platform.adobe.io/data/core/dps

{QUERY_PARAMS}

Valfria frågeparametrar för att filtrera resultat efter.

limit=2

Begäran

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}'

Använda frågeparametrar using-query-parameters

Du kan använda frågeparametrar för att sidgranska och filtrera resultat när du visar resurser.

Sidindelning paging

De vanligaste frågeparametrarna för sidindelning är:

Parameter

Beskrivning

Exempel

property

En valfri egenskap:

Egenskaperna grupperas efter AND-åtgärd.
Parametrar kan upprepas så här: property={PROPERTY_EXPR}[&property={PROPERTY_EXPR2}…] eller property={PROPERTY_EXPR1}[,{PROPERTY_EXPR2}…]
Egenskapsuttryck har formatet [ !]field[op]value, med op i [==,!=,<=,>=,<,>,~], som stöder reguljära uttryck.

property=name!=abc&property=id~.*1234.*&property=description equivalent with property=name!=abc,id~.*1234.*,description.

orderBy

Sortera resultat efter en specifik egenskap. Om du lägger till ett - före namn (orderBy=-name) sorteras objekten efter namn i fallande ordning (Z-A). Banuttryck är i form av punktavgränsade banor. Den här parametern kan upprepas så här: orderby=field1[,-fields2,field3,...]

orderby=id,-name

limit

Begränsa antalet enheter som returneras.

limit=5

Svar

Ett godkänt svar returnerar en lista med samlingar som finns i den behållare som du har åtkomst till.

{
    "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