Obtention d’un exemple d’opération d’API de modèle

IMPORTANT

Point de terminaison de l’API: https://platform.adobe.io/data/core/activation/authoring/testing/template/sample

Cette page répertorie et décrit toutes les opérations d’API que vous pouvez effectuer à l’aide du /authoring/testing/template/sample point d’entrée d’API, pour générer un modèle de transformation des messages pour votre destination. Pour une description de la fonctionnalité prise en charge par ce point de terminaison, reportez-vous à la section créer un modèle.

Prise en main des exemples d’opérations de l’API de modèle

Avant de poursuivre, veuillez consulter la section guide de prise en main pour obtenir des informations importantes à connaître afin d’effectuer avec succès des appels vers l’API, notamment sur la manière d’obtenir l’autorisation de création de destination requise et les en-têtes requis.

Obtenir un exemple de modèle

Vous pouvez obtenir un exemple de modèle en adressant une requête de GET à la fonction authoring/testing/template/sample/ point de terminaison et fournissant l’identifiant de destination de la configuration de destination selon laquelle vous créez votre modèle.

CONSEIL
  • L’identifiant de destination que vous devez utiliser ici est le suivant : instanceId qui correspond à une configuration de destination, créée à l’aide du /destinations point de terminaison . Reportez-vous à la section référence de l’API de configuration de destination.

Format d’API

GET authoring/testing/template/sample/{DESTINATION_ID}
Paramètre Description
{DESTINATION_ID} L’identifiant de la configuration de destination pour laquelle vous générez un modèle de transformation de message.

Requête

La requête suivante génère un nouvel exemple de modèle, configuré par les paramètres fournis dans la 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}' \

Réponse

Une réponse réussie renvoie un état HTTP 200 avec un exemple de modèle que vous pouvez modifier pour correspondre au format de données attendu.

Si l’identifiant de destination que vous fournissez correspond à une configuration de destination avec agrégation des meilleurs efforts et maxUsersPerRequest=1 dans la stratégie d’agrégation, la requête renvoie un exemple de modèle similaire à celui-ci :

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

Si l’identifiant de destination que vous fournissez correspond à un modèle de serveur de destination avec agrégation configurable ou agrégation des meilleurs efforts avec maxUsersPerRequest supérieur à un, la requête renvoie un exemple de modèle similaire à celui-ci :

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

Gestion des erreurs d’API

Les points de terminaison de l’API Destination SDK suivent les principes généraux des messages d’erreur de l’API Experience Platform. Voir Codes d’état d’API et erreurs d’en-tête de requête dans le guide de dépannage de Platform.

Étapes suivantes

Après avoir lu ce document, vous savez maintenant comment générer un modèle de transformation de message à l’aide du /authoring/testing/template/sample Point d’entrée de l’API. Vous pouvez ensuite utiliser la variable Point d’entrée de l’API de modèle de rendu pour générer les profils exportés en fonction du modèle et les comparer au format de données attendu de votre destination.

Sur cette page