Gerar perfis de amostra com base em um esquema de origem

Última atualização em 2023-11-01
  • Tópicos
  • Destinations
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer
    User
    Admin
    Leader
IMPORTANTE

Ponto de acesso da API: https://platform.adobe.io/data/core/activation/authoring/sample-profiles

Esta página lista e descreve todas as operações de API que você pode executar usando o /authoring/sample-profiles Endpoint da API.

Gerar tipos de perfil diferentes para APIs diferentes

IMPORTANTE

Use esse endpoint de API para gerar perfis de amostra para dois casos de uso separados. Você pode:

Você pode gerar perfis de amostra com base no esquema de origem XDM do Adobe (para usar ao testar o destino) ou no esquema de destino compatível com o destino (para usar ao criar o modelo). Para entender a diferença entre o esquema de origem XDM do Adobe e o esquema de destino, leia a seção de visão geral do Formato da mensagem artigo.

Observe que as finalidades para as quais os perfis de amostra podem ser usados não são intercambiáveis. Perfis gerados com base no ID de destino O só pode ser usado para criar modelos de transformação de mensagens e perfis gerados com base no ID da instância de destino O só pode ser usado para testar o endpoint de destino.

Introdução a operações de API de geração de perfil de amostra

Antes de continuar, reveja o guia de introdução para obter informações importantes que você precisa saber para fazer chamadas com êxito para a API, incluindo como obter a permissão de criação de destino e os cabeçalhos necessários.

Gerar perfis de amostra com base no esquema de origem a ser usado ao testar o destino

IMPORTANTE

Adicionar os perfis de amostra gerados aqui a chamadas HTTP quando testar o destino.

Você pode gerar perfis de amostra com base no esquema de origem fazendo uma solicitação GET para o authoring/sample-profiles/ e fornecendo a ID de uma instância de destino que você criou com base na configuração de destino que deseja testar.

Para obter a ID de uma instância de destino, primeiro crie uma conexão na interface do usuário do Experience Platform com seu destino antes de tentar testar seu destino. Leia o ativar tutorial de destino e consulte a dica abaixo para obter a ID de instância de destinos para usar com essa API.

IMPORTANTE

Formato da API

GET authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={COUNT}
Parâmetro da consulta Descrição
{DESTINATION_INSTANCE_ID} A ID da instância de destino com base na qual você está gerando perfis de amostra.
{COUNT} Opcional. O número de perfis de amostra que você está gerando. O parâmetro pode assumir valores entre 1 - 1000.
Se o parâmetro count não for especificado, o número padrão de perfis gerados será determinado pelo parâmetro maxUsersPerRequest valor no configuração do servidor de destino. Se essa propriedade não estiver definida, o Adobe gerará um perfil de amostra.

Solicitação

A solicitação a seguir gera perfis de exemplo, configurados pelo {DESTINATION_INSTANCE_ID} e {COUNT} parâmetros de consulta.

curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 com o número especificado de perfis de amostra, com associação de público-alvo, identidades e atributos de perfil que correspondem ao esquema XDM de origem.

DICA

A resposta retorna somente a associação de público-alvo, as identidades e os atributos de perfil que são usados na instância de destino. Mesmo se o esquema de origem tiver outros campos, eles serão ignorados.

[
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-7VEsJ"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-Y55JJ"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-Nd9GK"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    }
]
Propriedade Descrição
segmentMembership Um objeto de mapa que descreve as associações de público-alvo do indivíduo. Para obter mais informações sobre segmentMembership, ler Detalhes da associação do público-alvo.
lastQualificationTime Um carimbo de data e hora da última vez que esse perfil se qualificou para o segmento.
xdm:status Um campo de string que indica se a associação de público-alvo foi realizada como parte da solicitação atual. Os seguintes valores são aceitos:
  • realized: O perfil faz parte do segmento.
  • exited: o perfil está saindo do público-alvo como parte da solicitação atual.
identityMap Um campo do tipo mapa que descreve os vários valores de identidade para um indivíduo, juntamente com seus namespaces associados. Para obter mais informações sobre identityMap, ler Base da composição do esquema.

Gerar perfis de amostra com base no schema de destino a ser usado ao criar um template de transformação de mensagem

IMPORTANTE

Use os perfis de amostra gerados aqui ao criar seu modelo, na etapa do modelo de renderização.

Você pode gerar perfis de amostra com base no schema de destino fazendo uma solicitação GET para o authoring/sample-profiles/ e fornecer a ID de destino da configuração de destino com base na qual você está criando seu template.

DICA
  • A ID de destino que você deve usar aqui é a instanceId que corresponde a uma configuração de destino, criada usando o /destinations terminal. Consulte recuperar uma configuração de destino para obter mais detalhes.

Formato da API

GET authoring/sample-profiles?destinationId={DESTINATION_ID}&count={COUNT}
Parâmetro da consulta Descrição
{DESTINATION_ID} A ID da configuração de destino com base na qual você está gerando perfis de amostra.
{COUNT} Opcional. O número de perfis de amostra que você está gerando. O parâmetro pode assumir valores entre 1 - 1000.
Se o parâmetro count não for especificado, o número padrão de perfis gerados será determinado pelo parâmetro maxUsersPerRequest valor no configuração do servidor de destino. Se essa propriedade não estiver definida, o Adobe gerará um perfil de amostra.

Solicitação

A solicitação a seguir gera perfis de exemplo, configurados pelo {DESTINATION_ID} e {COUNT} parâmetros de consulta.

curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Resposta

Uma resposta bem-sucedida retorna o status HTTP 200 com o número especificado de perfis de amostra, com associação de público-alvo, identidades e atributos de perfil que correspondem ao esquema XDM do público-alvo.

[
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609326Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609328Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609328Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-vizii"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-adKYs"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-t4sKv"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-C3enB"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-bfnbs"
                }
            ]
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609626Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609627Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609627Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-6YjGc"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-SfJ21"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-eQMWS"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-d3WzP"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-eWfFn"
                }
            ]
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609823Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609824Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609824Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-2PMjZ"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-3aLez"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-D2H1J"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-i6PsF"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-VPUtZ"
                }
            ]
        }
    }
]

Manipulação de erros de API

Os endpoints da API Destination SDK seguem os princípios gerais de mensagem de erro da API Experience Platform. Consulte Códigos de status da API e erros no cabeçalho da solicitação no guia de solução de problemas da Platform.

Próximas etapas

Depois de ler este documento, agora você sabe como gerar perfis de amostra a serem usados quando teste de um template de transformação de mensagem ou quando testando se o destino está configurado corretamente.

Nesta página