Abrufen von Beispielvorlagen-API-Vorgängen

WICHTIG

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

Auf dieser Seite werden alle API-Vorgänge aufgelistet und beschrieben, die Sie mit dem /authoring/testing/template/sample API-Endpunkt, um eine Nachrichtenumwandlungsvorlage für Ihr Ziel. Eine Beschreibung der von diesem Endpunkt unterstützten Funktionen finden Sie unter Vorlage erstellen.

Erste Schritte mit API-Vorlagenvorgängen

Bevor Sie fortfahren, lesen Sie bitte die Erste Schritte für wichtige Informationen, die Sie benötigen, um die API erfolgreich aufrufen zu können, einschließlich Informationen zum Abrufen der erforderlichen Authoring-Berechtigung für Ziele und der erforderlichen Kopfzeilen.

Beispielvorlage abrufen

Sie können eine Beispielvorlage abrufen, indem Sie eine GET-Anfrage an die authoring/testing/template/sample/ -Endpunkt und die Ziel-ID der Zielkonfiguration angeben, basierend auf der Sie Ihre Vorlage erstellen.

TIPP
  • Die Ziel-ID, die Sie hier verwenden sollten, ist die instanceId , die einer Zielkonfiguration entspricht, die mithilfe der /destinations -Endpunkt. Siehe Abschnitt API-Referenz zur Zielkonfiguration.

API-Format

GET authoring/testing/template/sample/{DESTINATION_ID}
Parameter Beschreibung
{DESTINATION_ID} Die ID der Zielkonfiguration, für die Sie eine Nachrichtenumwandlungsvorlage generieren.

Anfrage

Die folgende Anfrage generiert eine neue Beispielvorlage, die von den in der Payload bereitgestellten Parametern 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: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit einer Beispielvorlage zurück, die Sie bearbeiten können, um Ihrem erwarteten Datenformat zu entsprechen.

Wenn die von Ihnen angegebene Ziel-ID einer Zielkonfiguration mit Aggregation des besten Aufwands und maxUsersPerRequest=1 in der Aggregationsrichtlinie 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 segments 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 Zielservervorlage mit konfigurierbare Aggregation oder Aggregation des besten Aufwands mit maxUsersPerRequest größer als 1, 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 segments 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

Destination SDK-API-Endpunkte folgen den allgemeinen Grundsätzen der Experience Platform API-Fehlermeldung. Siehe API-Statuscodes und Fehler in der Anfragekopfzeile im Handbuch zur Fehlerbehebung bei Platform.

Nächste Schritte

Nach dem Lesen dieses Dokuments wissen Sie jetzt, wie Sie eine Nachrichtenumwandlungsvorlage mit dem /authoring/testing/template/sample API-Endpunkt. Als Nächstes können Sie die API-Endpunkt für Rendervorlage , um exportierte Profile basierend auf der Vorlage zu generieren und mit dem erwarteten Datenformat Ihres Ziels zu vergleichen.

Auf dieser Seite