Dokumentation Experience Platform Zielhandbuch

Testen Ihres dateibasierten Ziels mit Beispielprofilen

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Themen:
Ziele

Erstellt für:

Admin
Benutzende

Übersicht overview

Auf dieser Seite wird erläutert, wie Sie den API-Endpunkt /testing/destinationInstance verwenden, um zu testen, ob Ihr dateibasiertes Ziel richtig konfiguriert ist, und um die Integrität der Datenflüsse zu Ihrem konfigurierten Ziel zu überprüfen.

Sie können Anfragen an den Test-Endpunkt mit oder ohne Hinzufügen von Beispielprofilen an den Aufruf stellen. Wenn Sie bei der Anfrage keine Profile senden, generiert die API automatisch ein Beispielprofil und fügt es der Anfrage hinzu.

Die automatisch generierten Beispielprofile enthalten allgemeine Daten. Wenn Sie Ihr Ziel mit benutzerdefinierten, intuitiveren Profildaten testen möchten, verwenden Sie die Beispielprofilgenerierungs-API , um ein Beispielprofil zu generieren, dann die Antwort anzupassen und sie in die Anfrage an den Endpunkt /testing/destinationInstance aufzunehmen.

Erste Schritte getting-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.

Voraussetzungen prerequisites

Bevor Sie den Endpunkt /testing/destinationInstance verwenden, stellen Sie sicher, dass Sie die folgenden Bedingungen erfüllen:

Sie haben ein vorhandenes dateibasiertes Ziel, das über das Destination SDK erstellt wurde, und Sie können es in Ihrem Zielkatalog sehen.
Sie haben in der Experience Platform-Benutzeroberfläche mindestens einen Aktivierungsfluss für Ihr Ziel erstellt.
Für eine erfolgreiche API-Anfrage benötigen Sie die Ziel-Instanz-ID, die der zu testenden Zielinstanz entspricht. Rufen Sie die Ziel-Instanz-ID ab, die Sie beim Durchsuchen einer Verbindung mit Ihrem Ziel in der Platform-Benutzeroberfläche im API-Aufruf über die URL verwenden sollten.
Optional: Wenn Sie Ihre Zielkonfiguration mit einem Beispielprofil testen möchten, das zum API-Aufruf hinzugefügt wurde, verwenden Sie den Endpunkt /sample-profiles, um ein Beispielprofil zu generieren, das auf Ihrem vorhandenen Quellschema basiert. Wenn Sie kein Beispielprofil angeben, generiert die API ein Profil und gibt es in der Antwort zurück.

Testen Sie Ihre Zielkonfiguration, ohne Profile zum Aufruf hinzuzufügen test-without-adding-profiles

API-Format

POST /authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}

Anfrage

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}' \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

Pfadparameter

Beschreibung

{DESTINATION_INSTANCE_ID}

Die ID der Zielinstanz, für die Sie Beispielprofile generieren. Im Abschnitt Voraussetzungen finden Sie weitere Informationen zum Abrufen dieser ID.

Antwort

Bei einer erfolgreiche Antwort wird der HTTP-Status 200 zusammen mit der Antwort-Payload zurückgegeben.

{
   "activations":[
      {
         "segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
      },
      {
         "segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
      }
   ],
   "results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"john.smith@abc.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"crmid-P1A7l"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"string",
               "lastName":"string"
            }
         }
      }
   ]
}

Eigenschaft

Beschreibung

activations

Gibt für jede aktivierte Zielgruppe die Zielgruppen-ID und die Flussausführungs-ID zurück. Die Anzahl der Aktivierungseinträge (und der zugehörigen generierten Dateien) entspricht der Anzahl der Zielgruppen, die der Zielinstanz zugeordnet sind.

Beispiel: Wenn Sie der Zielinstanz zwei Zielgruppen zugeordnet haben, enthält das Array activations zwei Einträge. Jede aktivierte Zielgruppe entspricht einer exportierten Datei.

results

Gibt die ID der Zielinstanz und die IDs der Flussausführung zurück, die Sie zum Aufrufen der Ergebnis-API verwenden können, um die Integration weiter zu testen.

inputProfiles

Gibt die von der API automatisch generierten Beispielprofile zurück.

Testen Sie Ihre Zielkonfiguration mit Profilen, die zum Aufruf hinzugefügt wurden test-with-added-profiles

Um Ihr Ziel mit benutzerdefinierten, intuitiveren Profildaten zu testen, können Sie die vom Endpunkt /sample-profiles erhaltene Antwort mit Werten Ihrer Wahl anpassen und das benutzerdefinierte Profil in die Anfrage an den Endpunkt /testing/destinationInstance einschließen.

API-Format

POST  /testing/destinationInstance/{DESTINATION_INSTANCE_ID}

Anfrage

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}'
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
 {
   "profiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"michaelsmith@example.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"Custom CRM ID"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"Michael",
               "lastName":"Smith"
            }
         }
      }
   ]
}'

Parameter

Beschreibung

{DESTINATION_INSTANCE_ID}

Die Ziel-Instanz-ID des Ziels, das Sie testen. Die ID der Zielinstanz, für die Sie Beispielprofile generieren. Im Abschnitt Voraussetzungen finden Sie weitere Informationen zum Abrufen dieser ID.

profiles

Array, das ein oder mehrere Profile enthalten kann. Verwenden Sie den Beispielprofil-API-Endpunkt, um Profile zu generieren, die in diesem API-Aufruf verwendet werden.

Antwort

Bei einer erfolgreiche Antwort wird der HTTP-Status 200 zusammen mit der Antwort-Payload zurückgegeben.

{
   "activations":[
      {
         "segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
      },
      {
         "segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
      }
   ],
   "results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"michaelsmith@example.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"Custom CRM ID"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"Michael",
               "lastName":"Smith"
            }
         }
      }
   ]
}

Eigenschaft

Beschreibung

activations

results

Gibt die ID der Zielinstanz und die IDs der Flussausführung zurück, die Sie zum Aufrufen der Ergebnis-API verwenden können, um die Integration weiter zu testen.

inputProfiles

Gibt die benutzerdefinierten Beispielprofile zurück, die Sie in der API-Anfrage übergeben haben.

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

Nach dem Lesen dieses Dokuments wissen Sie jetzt, wie Sie Ihre dateibasierte Zielkonfiguration testen können.

Wenn Sie eine gültige API-Antwort erhalten haben, funktioniert Ihr Ziel ordnungsgemäß. Wenn Sie genauere Informationen über Ihren Aktivierungsfluss erhalten möchten, können Sie die Eigenschaft results aus der Antwort verwenden, um detaillierte Aktivierungsergebnisse anzuzeigen.

Wenn Sie ein öffentliches Ziel erstellen, können Sie jetzt Ihre Zielkonfiguration zur Überprüfung an Adobe senden.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6