Auflisten von Sammlungen

Letzte Aktualisierung: 2024-01-22
  • Erstellt für:
  • Experienced
    Developer

Sammlungen sind Untergruppen von Angeboten, die auf von einem Marketing-Experten vordefinierten Bedingungen basieren, z. B. der Kategorie des Angebots.

Durch Ausführung einer einzelnen GET-Anfrage an die Offer Library-API können Sie eine Liste aller Sammlungen anzeigen.

API-Format

GET /{ENDPOINT_PATH}/offer-collections?{QUERY_PARAMS}
Parameter Beschreibung Beispiel
{ENDPOINT_PATH} Der Endpunktpfad für persistente APIs. https://platform.adobe.io/data/core/dps
{QUERY_PARAMS} Optionale Abfrageparameter zum Filtern der Ergebnisse. limit=2

Anfrage

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

Verwenden von Abfrageparametern

Beim Auflisten von Ressourcen können Sie Abfrageparameter nutzen, um Ergebnisse zu sortieren und zu filtern.

Paging

Zu den häufigsten Abfrageparametern für das Paging gehören:

Parameter Beschreibung Beispiel
property Ein optionaler Eigenschaftenfilter:
  • Die Eigenschaften werden nach UND-Vorgang gruppiert.
  • Parameter können wie folgt wiederholt werden: property={PROPERTY_EXPR}[&property={PROPERTY_EXPR2}…] oder property={PROPERTY_EXPR1}[,{PROPERTY_EXPR2}…]
  • Eigenschaftenausdrücke haben das Format [!]field[op]value, mit op in [==,!=,<=,>=,<,>,~], wobei reguläre Ausdrücke unterstützt werden.
property=name!=abc&property=id~.*1234.*&property=description equivalent with property=name!=abc,id~.*1234.*,description.
orderBy Sortieren Sie die Ergebnisse nach einer bestimmten Eigenschaft. Durch Hinzufügen eines „-“ vor dem Namen (orderby=-name) werden Elemente nach Namen in absteigender Reihenfolge sortiert (Z–A). Pfadausdrücke haben die Form von durch Punkte getrennten Pfaden. Dieser Parameter kann wie folgt wiederholt werden: orderby=field1[,-fields2,field3,...] orderby=id,-name
limit Begrenzt die Anzahl der zurückgegebenen Entitäten. limit=5

Antwort

Eine erfolgreiche Antwort gibt eine Liste von Sammlungen zurück, die in dem Container vorhanden sind, auf den Sie Zugriff haben.

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

Auf dieser Seite