Generera en omformningsmall för exempelmeddelanden get-sample-template-api-operations
https://platform.adobe.io/data/core/activation/authoring/testing/template/samplePå den här sidan visas och beskrivs alla API-åtgärder som du kan utföra med API-slutpunkten /authoring/testing/template/sample för att generera en meddelandetransformeringsmall för ditt mål. 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 get-started
Innan du fortsätter bör du läsa igenom kom igång-guiden för att få viktig information som du behöver känna till för att kunna ringa anrop till API:t, inklusive hur du får nödvändig behörighet för målredigering och nödvändiga rubriker.
Hämta exempelmall generate-sample-template
Du kan hämta en exempelmall genom att göra en GET-förfrågan till authoring/testing/template/sample/-slutpunkten och ange mål-ID:t för målkonfigurationen baserat på vilken du skapar mallen.
- Mål-ID som du bör använda här är
instanceIdsom motsvarar en målkonfiguration, som skapas med slutpunkten/destinations. Mer information finns i Hämta en målkonfiguration.
API-format
GET authoring/testing/template/sample/{DESTINATION_ID}
{DESTINATION_ID}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 som du anger motsvarar en målkonfiguration med bästa ansträngningsaggregering och maxUsersPerRequest=1 i aggregeringsprincipen returnerar begäran en exempelmall som liknar den här:
{#- 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 som du anger motsvarar en målservermall med konfigurerbar aggregering eller bästa ansträngningsaggregering med maxUsersPerRequest större ä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 api-error-handling
Destination SDK-API-slutpunkter följer de allmänna felmeddelandeprinciperna för Experience Platform API. Se API-statuskoder och begäranrubrikfel i felsökningsguiden för plattformen.
Nästa steg next-steps
När du har läst det här dokumentet vet du nu hur du genererar en meddelandetransformeringsmall med API-slutpunkten /authoring/testing/template/sample. Sedan kan du använda Återgivningsmallens 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.