Documentação Journey Optimizer Guia do Journey Optimizer

Listar fórmulas de classificação

10 de março de 2025

Criado para:

Experiente
Desenvolvedor

Uma fórmula de classificação consiste em uma função de classificação que define como ela deve classificar.

É possível exibir uma lista de todas as fórmulas de classificação executando uma única solicitação do GET para a API da Biblioteca de ofertas.

Formato da API

GET /{ENDPOINT_PATH}/ranking-formulas?{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}

exdFunction.

property=exdFunction%3D%3Dtrue

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

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/ranking-formulas?property=exdFunction%3D%3Dtrue&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 fórmulas de classificação às quais você tem acesso.

{
    "results": [
        {
            "created": "2024-08-08T23:45:15.380Z",
            "modified": "2024-10-22T18:15:05.909Z",
            "etag": 36,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/ranking-function"
            ],
            "createdBy": "71486D7B5F4011980A494030@AdobeID",
            "lastModifiedBy": "71486D7B5F4011980A494030@AdobeID",
            "id": "dps:ranking-function:1947f5372cc4ed74",
            "name": "[Do not delete] - Cypress e2e - edit",
            "description": "some description",
            "returnType": {
                "type": "INTEGER"
            },
            "exdFunction": true,
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "42 = 11"
            }
        },
        {
            "created": "2024-05-03T13:06:22.361Z",
            "modified": "2024-10-18T22:47:35.396Z",
            "etag": 2,
            "schemas": [
                "https://ns.adobe.com/experience/offer-management/ranking-function;version=0.3"
            ],
            "createdBy": "FD62391F5B44DF970A494124@AdobeID",
            "lastModifiedBy": "6F8A6FF05F4011C40A494005@AdobeID",
            "id": "xcore:ranking-function:18ca80c5b15c5e11",
            "name": "doc test exd",
            "description": "",
            "returnType": {
                "type": "INTEGER"
            },
            "exdFunction": true,
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "false"
            }
        }
    ],
    "count": 2,
    "total": 50,
    "_links": {
        "self": {
            "href": "/ranking-formulas?orderby=-modified&limit=2",
            "type": "application/json"
        },
        "next": {
            "href": "/ranking-formulas?orderby=-modified&limit=2&start=2024-10-18T22:22:35.048Z",
            "type": "application/json"
        }
    }
}

recommendation-more-help