Documentação Journey Optimizer Guia do Journey Optimizer

Listar coleções de itens

Última atualização: 2 de outubro de 2024

Criado para:

Experiente
Desenvolvedor

As coleções, também conhecidas como coleções de itens, permitem categorizar e agrupar os itens de decisão de acordo com suas preferências. Essas categorias são criadas pela construção de regras que aproveitam os atributos de itens de decisão.

É possível exibir uma lista de todas as coleções de itens executando uma única solicitação do GET para a API da biblioteca de ofertas.

Formato da API

GET /{ENDPOINT_PATH}/item-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`

Uso de parâmetros de consulta

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

Paginação

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

Parâmetro Descrição Exemplo

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`

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

Solicitação

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

Resposta

Uma resposta bem-sucedida retorna uma lista de coleções de itens às quais você tem acesso.

{
    "results": [
        {
            "created": "2024-01-31T18:28:52.888Z",
            "modified": "2024-06-28T19:44:13.112Z",
            "etag": 7,
            "schemas": [
                "https://ns.adobe.com/experience/decisioning/item-collection;version=1.2"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "itemCollection1234",
            "name": "Item collection One",
            "description": "Item collection",
            "constraints": [
                {
                    "itemCatalogId": "itemCatalog1234",
                    "uiModel": "{\"operator\":\"equals\",\"value\":{\"left\":\"_experience.decisioning.decisionitem.itemName\",\"right\":\"Some offer item\"}}"
                }
            ],
            "tags": []
        },
        {
            "created": "2024-06-10T16:02:57.878Z",
            "modified": "2024-06-10T16:02:57.878Z",
            "etag": 1,
            "schemas": [
                "https://ns.adobe.com/experience/decisioning/item-collection;version=1.2"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "itemCollection5678",
            "name": "Item collection One",
            "description": "Item collection",
            "constraints": [
                {
                    "itemCatalogId": "itemCatalog1234",
                    "uiModel": "{\"operator\":\"greater than\",\"value\":{\"left\":\"_<imsOrg>.some_integer\",\"right\":100}}"
                }
            ],
            "tags": []
        }
    ],
    "count": 2,
    "total": 166,
    "_links": {
        "self": {
            "href": "/item-collections?orderby=-modified&limit=2",
            "type": "application/json"
        },
        "next": {
            "href": "/item-collections?orderby=-modified&limit=2&start=2024-06-04T23:37:33.980Z",
            "type": "application/json"
        }
    }
}

recommendation-more-help