Gerar um modelo de transformação de mensagem de amostra get-sample-template-api-operations

IMPORTANT
Ponto de acesso da API: https://platform.adobe.io/data/core/activation/authoring/testing/template/sample

Esta página lista e descreve todas as operações de API que você pode executar usando o /authoring/testing/template/sample Endpoint da API, para gerar um template de transformação de mensagem para o seu destino. Para obter uma descrição da funcionalidade compatível com esse endpoint, leia criar modelo.

Introdução às operações de amostra de API de modelo get-started

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.

Obter modelo de amostra generate-sample-template

Você pode obter um modelo de amostra fazendo uma solicitação GET para a authoring/testing/template/sample/ e fornecer a ID de destino da configuração de destino com base na qual você está criando seu template.

TIP
  • 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 a recuperar uma configuração de destino para obter mais detalhes.

Formato da API

GET authoring/testing/template/sample/{DESTINATION_ID}
Parâmetro
Descrição
{DESTINATION_ID}
A ID da configuração de destino para a qual você está gerando um modelo de transformação de mensagem.

Solicitação

A solicitação a seguir gera um novo modelo de amostra, configurado pelos parâmetros fornecidos na carga.

curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/testing/template/sample/5114d758-ce71-43ba-b53e-e2a91d67b67f' \
--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 um modelo de amostra que você pode editar para corresponder ao formato de dados esperado.

Se a ID de destino fornecida corresponder a uma configuração de destino com agregação de melhor esforço e maxUsersPerRequest=1 na política de agregação, a solicitação retorna um template de amostra semelhante a este:

{#- THIS is an example template for a single profile -#}
{#- A '-' at the beginning or end of a tag removes all whitespace on that side of the tag. -#}
{
    "identities": [
    {%- for idMapEntry in input.profile.identityMap -%}
    {%- set namespace = idMapEntry.key -%}
        {%- for identity in idMapEntry.value %}
        {
            "type": "{{ namespace }}",
            "id": "{{ identity.id }}"
        }{%- if not loop.last -%},{%- endif -%}
        {%- endfor -%}{%- if not loop.last -%},{%- endif -%}
    {% endfor %}
    ],
    "AdobeExperiencePlatformSegments": {
        "add": [
        {%- for segment in input.profile.segmentMembership.ups | added %}
            "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
        {% endfor %}
        ],
        "remove": [
        {#- Alternative syntax for filtering audiences by status: -#}
        {% for segment in removedSegments(input.profile.segmentMembership.ups) %}
            "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
        {% endfor %}
        ]
    }
}

Se a ID de destino fornecida corresponder a um modelo de servidor de destino com agregação configurável ou agregação de melhor esforço com maxUsersPerRequest maior que um, a solicitação retorna um modelo de amostra semelhante a este:

{#- THIS is an example template for multiple profiles -#}
{#- A '-' at the beginning or end of a tag removes all whitespace on that side of the tag. -#}
{
    "profiles": [
    {%- for profile in input.profiles %}
        {
            "identities": [
            {%- for idMapEntry in profile.identityMap -%}
            {%- set namespace = idMapEntry.key -%}
                {%- for identity in idMapEntry.value %}
                {
                    "type": "{{ namespace }}",
                    "id": "{{ identity.id }}"
                }{%- if not loop.last -%},{%- endif -%}
                {%- endfor -%}{%- if not loop.last -%},{%- endif -%}
            {% endfor %}
            ],
            "AdobeExperiencePlatformSegments": {
                "add": [
                {%- for segment in profile.segmentMembership.ups | added %}
                    "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
                {% endfor %}
                ],
                "remove": [
                {#- Alternative syntax for filtering audiences by status: -#}
                {% for segment in removedSegments(profile.segmentMembership.ups) %}
                    "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
                {% endfor %}
                ]
            }
        }{%- if not loop.last -%},{%- endif -%}
    {% endfor %}
    ]
}

Manipulação de erros de API api-error-handling

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 next-steps

Depois de ler este documento, agora você sabe como gerar um modelo de transformação de mensagem usando o /authoring/testing/template/sample Endpoint da API. Em seguida, você pode usar o Renderizar ponto de extremidade de API de modelo para gerar perfis exportados com base no modelo e compará-los com o formato de dados esperado do destino.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6