Listar coleções list-collections

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

Aplica-se a:
Journey Orchestration

Criado para:

Experiente
Desenvolvedor

TIP

O serviço de Decisão, o novo recurso de tomada de decisão do Adobe Journey Optimizer, agora está disponível por meio da experiência baseada em código e dos canais de email. Saiba mais

Coleções são subconjuntos de ofertas com base em condições predefinidas por um profissional de marketing, como a categoria da oferta.

Você pode exibir uma lista de todas as coleções executando uma única solicitação GET para a API Offer Library.

Formato da API

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

Parâmetro

Descrição

Exemplo

{ENDPOINT_PATH}

O caminho do endpoint para APIs de persistência.

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

{QUERY_PARAMS}

Parâmetros de consulta opcionais para filtrar os resultados.

limit=2

Solicitação

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

Uso de parâmetros de consulta using-query-parameters

Você pode usar parâmetros de consulta para paginar e filtrar resultados ao listar recursos.

Paginação paging

Os parâmetros de consulta mais comuns para paginação incluem:

Parâmetro

Descrição

Exemplo

property

Um filtro de propriedade opcional:

As propriedades são agrupadas por operação AND.
Os parâmetros podem ser repetidos da seguinte forma: property={PROPERTY_EXPR}[&property={PROPERTY_EXPR2}…] or property={PROPERTY_EXPR1}[,{PROPERTY_EXPR2}…]
As expressões de propriedade estão no formato [ !]field[op]value, com op em [==,!=,<=,>=,<,>,~], com suporte para expressões regulares.

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

orderBy

Classificar os resultados por uma propriedade específica. Adicionar um - antes do nome (orderby=-name) classificará os itens pelo nome em ordem decrescente (Z-A). As expressões de caminho estão no formato de caminhos separados por pontos. Este parâmetro pode ser repetido assim: orderby=field1[,-fields2,field3,...]

orderby=id,-name

limit

Limitar o número de entidades retornadas.

limit=5

Resposta

Uma resposta bem-sucedida retorna uma lista de coleções presentes no contêiner ao qual você tem acesso.

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