Generera en omformningsmall för exempelmeddelanden

Senaste uppdatering: 2023-07-14
  • Skapat för:
  • Developer
    User
    Admin
    Leader
VIKTIGT

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

På den här sidan visas och beskrivs alla API-åtgärder som du kan utföra med /authoring/testing/template/sample API-slutpunkt för att generera en omformningsmall för meddelanden till destinationen. En beskrivning av de funktioner som stöds av den här slutpunkten finns i skapa mall.

Komma igång med API-åtgärder för exempelmallar

Läs igenom komma igång-guide för viktig information som du behöver känna till för att kunna anropa API:t, inklusive hur du får nödvändig behörighet för målredigering och obligatoriska huvuden.

Hämta exempelmall

Du kan hämta en exempelmall genom att göra en GET-förfrågan till authoring/testing/template/sample/ slutpunkt och ange mål-ID för den målkonfiguration som du skapar mallen utifrån.

TIPS
  • Mål-ID som du ska använda här är instanceId som motsvarar en målkonfiguration, skapad med /destinations slutpunkt. Se hämta en destinationskonfiguration för mer information.

API-format

GET authoring/testing/template/sample/{DESTINATION_ID}
Parameter Beskrivning
{DESTINATION_ID} ID:t för målkonfigurationen som du genererar en meddelandetransformeringsmall för.

Begäran

Följande begäran genererar en ny exempelmall som konfigurerats med parametrarna i nyttolasten.

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

Svar

Ett lyckat svar returnerar HTTP-status 200 med en exempelmall som du kan redigera för att matcha det förväntade dataformatet.

Om det mål-ID du anger motsvarar en målkonfiguration med bästa ansträngningsaggregering och maxUsersPerRequest=1 I sammansättningsprincipen returnerar begäran en exempelmall som liknar denna:

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

Om det mål-ID du anger motsvarar en målservermall med konfigurerbar aggregering eller bästa ansträngningsaggregering med maxUsersPerRequest mer än en, returnerar begäran en exempelmall som liknar denna:

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

API-felhantering

Destination SDK-API-slutpunkter följer de allmänna felmeddelandeprinciperna för Experience Platform API. Se API-statuskoder och fel i begäranhuvudet i felsökningsguiden för plattformen.

Nästa steg

När du har läst det här dokumentet vet du nu hur du skapar en meddelandeomformningsmall med hjälp av /authoring/testing/template/sample API-slutpunkt. Nu kan du använda Återge mall-API-slutpunkt för att generera exporterade profiler som är baserade på mallen och jämföra dem med målets förväntade dataformat.

På denna sida