Elencare raccolte list-collections

Le raccolte sono sottoinsiemi di offerte basate su condizioni predefinite definite da un addetto marketing, ad esempio la categoria dell’offerta.

Per visualizzare un elenco di tutte le raccolte, devi eseguire una singola richiesta GET al Offer Library API.

Formato API

GET /{ENDPOINT_PATH}/offer-collections?{QUERY_PARAMS}
Parametro
Descrizione
Esempio
{ENDPOINT_PATH}
Percorso endpoint per le API di persistenza.
https://platform.adobe.io/data/core/dps
{QUERY_PARAMS}
Parametri di query facoltativi in base ai quali filtrare i risultati.
limit=2

Richiesta

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

Utilizzo dei parametri di query using-query-parameters

Puoi utilizzare i parametri di query per visualizzare e filtrare i risultati quando elenchi le risorse.

Paging paging

I parametri di query più comuni per il paging includono:

Parametro
Descrizione
Esempio
property

Un filtro proprietà facoltativo:

  • Le proprietà sono raggruppate per operazione AND.
  • I parametri possono essere ripetuti come segue: property={PROPERTY_EXPR}[&property={PROPERTY_EXPR2}…] or property={PROPERTY_EXPR1}[,{PROPERTY_EXPR2}…]
  • Le espressioni di proprietà sono in formato [ !]field[op]value, con op in [==,!=,<=,>=,<,>,~], con supporto di espressioni regolari.
property=name!=abc&property=id~.*1234.*&property=description equivalent with property=name!=abc,id~.*1234.*,description.
orderBy
Ordinare i risultati per una proprietà specifica. Se si aggiunge un segno - prima del nome (orderby=-name), gli elementi verranno ordinati in base al nome in ordine decrescente (Z-A). Le espressioni di percorso sono sotto forma di percorsi separati da punti. Questo parametro può essere ripetuto come segue: orderby=field1[,-fields2,field3,...]
orderby=id,-name
limit
Limita il numero di entità restituite.
limit=5

Risposta

In caso di esito positivo, la risposta restituisce un elenco di raccolte presenti all’interno del contenitore a cui hai accesso.

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