Ottieni operazioni API di esempio

IMPORTANTE

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

In questa pagina sono elencate e descritte tutte le operazioni API che è possibile eseguire utilizzando l’ endpoint API /authoring/testing/template/sample per generare un modello di trasformazione dei messaggi per la destinazione. Per una descrizione delle funzionalità supportate da questo endpoint, leggere create template.

Guida introduttiva alle operazioni API con modelli di esempio

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

Ottieni modello di esempio

Puoi ottenere un modello di esempio effettuando una richiesta di GET all’ endpoint authoring/testing/template/sample/ e fornendo l’ID di destinazione della configurazione di destinazione in base alla quale stai creando il modello.

SUGGERIMENTO

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 del messaggio.

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: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Risposta

Una risposta corretta restituisce lo stato HTTP 200 con un modello di esempio che è possibile modificare per adattarlo al formato di dati previsto.

Se l'ID di destinazione fornito corrisponde a una configurazione di destinazione con aggregazione dello sforzo migliore e maxUsersPerRequest=1 nel criterio di aggregazione, la richiesta restituisce un modello di esempio simile a questo:

{#- 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 segments 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 dello sforzo migliore 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 segments 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

Gli endpoint API SDK di destinazione seguono i principi generali dei messaggi di errore API di Experience Platform. Consulta Codici di stato API e richiedi errori di intestazione nella guida alla risoluzione dei problemi di Platform.

Passaggi successivi

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

In questa pagina