Erstellen einer Beispiel-Nachrichtenumwandlungsvorlage get-sample-template-api-operations
https://platform.adobe.io/data/core/activation/authoring/testing/template/sampleAuf dieser Seite werden alle API-Vorgänge aufgelistet und beschrieben, die Sie mit dem API-Endpunkt /authoring/testing/template/sample durchführen können, um eine Nachrichtenumwandlungsvorlage für Ihr Ziel zu generieren. Eine Beschreibung der von diesem Endpunkt unterstützten Funktionen finden Sie unter Erstellen einer Vorlage.
Erste Schritte mit API-Vorgängen für Beispielvorlagen get-started
Bevor Sie fortfahren, lesen Sie Erste Schritte. Dort finden Sie die nötigen Informationen für den erfolgreichen Aufruf der API, einschließlich Details für den Abruf der erforderlichen Authoring-Berechtigung für Ziele und zu den erforderlichen Kopfzeilen.
Abrufen einer Beispielvorlage generate-sample-template
Sie können eine Beispielvorlage abrufen, indem Sie eine GET-Anfrage an den Endpunkt authoring/testing/template/sample/ stellen und die Ziel-ID der Zielkonfiguration angeben, auf deren Grundlage Sie Ihre Vorlage erstellen.
- Die Ziel-ID, die Sie hier verwenden sollten, ist die
instanceId, die einer mithilfe des/destinations-Endpunkts erstellten Zielkonfiguration entspricht. Siehe Abschnitt Abrufen einer Zielkonfiguration für weitere Details.
API-Format
GET authoring/testing/template/sample/{DESTINATION_ID}
{DESTINATION_ID}Anfrage
Die folgende Anfrage erstellt eine neue Beispielvorlage, die durch die in der Payload angegebenen Parameter konfiguriert wird.
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}' \
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit einer Beispielvorlage zurückgegeben, die Sie bearbeiten können, um Ihrem erwarteten Datenformat zu entsprechen.
Wenn die von Ihnen angegebene Ziel-ID einer Zielkonfiguration mit Aggregation nach bestem Bemühen und maxUsersPerRequest=1 in der Aggregationsrichtlinie entspricht, gibt die Anfrage eine Beispielvorlage zurück, die der folgenden ähnelt:
{#- 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 %}
]
}
}
Wenn die von Ihnen angegebene Ziel-ID einer Ziel-Server-Vorlage mit konfigurierbarer Aggregation oder Aggregation nach bestem Bemühen mit maxUsersPerRequest größer als 1 entspricht, gibt die Anfrage eine Beispielvorlage zurück, die der folgenden ähnelt:
{#- 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 %}
]
}
Umgang mit API-Fehlern api-error-handling
Destination SDK-API-Endpunkte folgen den allgemeinen Grundsätzen von Experience Platform API-Fehlermeldungen. Siehe API-Status-Codes und Fehler im Anfrage-Header in der Anleitung zur Fehlerbehebung für Platform.
Nächste Schritte next-steps
Nach dem Lesen dieses Dokuments wissen Sie jetzt, wie Sie eine Nachrichtenumwandlungsvorlage mit dem /authoring/testing/template/sample API-Endpunkt generieren. Als Nächstes können Sie den Endpunkt für die Render-Vorlagen-API verwenden, um exportierte Profile basierend auf der Vorlage zu generieren und mit dem erwarteten Datenformat Ihres Ziels zu vergleichen.