Genera un esempio di modello di trasformazione dei messaggi get-sample-template-api-operations

IMPORTANT
Endpoint API: https://platform.adobe.io/data/core/activation/authoring/testing/template/sample

Questa pagina elenca e descrive tutte le operazioni API che è possibile eseguire utilizzando /authoring/testing/template/sample Endpoint API, per generare un modello di trasformazione dei messaggi per la tua destinazione. Per una descrizione delle funzionalità supportate da questo endpoint, leggere crea modello.

Guida introduttiva alle operazioni API dei modelli di esempio get-started

Prima di continuare, controlla guida introduttiva per informazioni importanti che è necessario conoscere per effettuare correttamente chiamate all’API, tra cui come ottenere l’autorizzazione di authoring della destinazione richiesta e le intestazioni richieste.

Ottieni modello di esempio generate-sample-template

Per ottenere un modello di esempio, devi effettuare una richiesta GET al authoring/testing/template/sample/ e fornendo l’ID di destinazione della configurazione di destinazione in base alla quale stai creando il modello.

TIP
  • L’ID di destinazione da utilizzare qui è il instanceId che corrisponde a una configurazione di destinazione, creata utilizzando /destinations endpoint. Consulta la sezione recuperare una configurazione di destinazione per ulteriori dettagli.

Formato API

GET authoring/testing/template/sample/{DESTINATION_ID}
Parametro
Descrizione
{DESTINATION_ID}
ID della configurazione di destinazione per la quale stai generando un modello di trasformazione dei messaggi.

Richiesta

La richiesta seguente genera un nuovo modello di esempio, configurato dai parametri forniti nel payload.

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}' \

Risposta

In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con un modello di esempio modificabile in base al formato di dati previsto.

Se l’ID di destinazione fornito corrisponde a una configurazione di destinazione con aggregazione della migliore fatica e maxUsersPerRequest=1 nel criterio di aggregazione, la richiesta restituisce un modello di esempio simile al seguente:

{#- 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 l’ID di destinazione fornito corrisponde a un modello di server di destinazione con aggregazione configurabile o aggregazione della migliore fatica con maxUsersPerRequest maggiore di uno, la richiesta restituisce un modello di esempio simile a questo:

{#- 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 %}
    ]
}

Gestione degli errori API api-error-handling

Gli endpoint API di Destination SDK seguono i principi generali dei messaggi di errore API di Experience Platform. Fai riferimento a Codici di stato API e errori di intestazione della richiesta nella guida alla risoluzione dei problemi di Platform.

Passaggi successivi next-steps

Dopo aver letto questo documento, ora sai come generare un modello di trasformazione dei messaggi utilizzando /authoring/testing/template/sample Endpoint API Quindi, puoi utilizzare Endpoint API del modello di rendering per generare profili esportati in base al modello e confrontarli con il formato di dati previsto della destinazione.

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