Documentação Journey Optimizer Guia do Journey Optimizer

Listar ofertas substitutas

Última atualização: 17 de julho de 2024

Criado para:

Experiente
Desenvolvedor

Uma oferta substituta é enviada aos clientes se eles não estiverem qualificados para outras ofertas. As etapas para criar uma oferta substituta consistem na criação de uma ou várias representações, como ao criar uma oferta.

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

Formato da API

GET /{ENDPOINT_PATH}/offers?offer-type=fallback&{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/offers?offer-type=fallback&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

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

Resposta

Uma resposta bem-sucedida retorna uma lista de ofertas substitutas às quais você tem acesso.

{
      "results": [
        {
            "created": "2023-06-08T14:04:41.011+00:00",
            "modified": "2023-06-08T14:04:41.011+00:00",
            "etag": 1,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.8"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "fallbackOffer1234",
            "name": "Fallback Offer Web",
            "description": "Fallback Offer Web Description",
            "status": "draft",
            "representations": [
                {
                    "channel": "https://ns.adobe.com/xdm/channel-types/web",
                    "placement": "offerPlacement5678",
                    "components": [
                        {
                            "type": "imagelink",
                            "format": "image/png",
                            "deliveryURL": "https://mysite.com"
                        }
                    ]
                }
            ]
        },
        {
            "created": "2022-10-07T11:23:55.885+00:00",
            "modified": "2022-10-07T11:23:55.885+00:00",
            "etag": 1,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.7"
            ],
            "createdBy": "{CREATED_BY}",
            "lastModifiedBy": "{MODIFIED_BY}",
            "id": "fallbackOffer5678",
            "name": "Fallback Offer email",
            "status": "approved",
            "representations": [
                {
                    "channel": "https://ns.adobe.com/xdm/channel-types/email",
                    "placement": "offerPlacement1234",
                    "components": [
                        {
                            "type": "component-text",
                            "format": "text/template",
                            "content": "Get free shipping!"
                        }
                    ]
                }
            ],
            "labels": [
                "core/C1"
            ]
        }
    ],
    "count": 2,
    "total": 3,
    "_links": {
        "self": {
            "href": "/offers?offer-type=fallback&href={SELF_HREF}&limit=2",
            "type": "application/json"
        },
        "next": {
            "href": "/offers?offer-type=fallback&href={NEXT_HREF}&limit=2",
            "type": "application/json"
        }
    }
}

recommendation-more-help