Testen Ihres dateibasierten Ziels mit Beispielprofilen

Übersicht

Auf dieser Seite wird erläutert, wie Sie die /testing/destinationInstance API-Endpunkt, 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 Anforderungen an den Test-Endpunkt mit oder ohne Hinzufügen von Beispielprofile an den -Aufruf. 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 seine Antwort anzupassen und es in die Anfrage an die /testing/destinationInstance -Endpunkt.

Erste Schritte

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

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

  • Sie haben ein vorhandenes dateibasiertes Ziel, das über die Destination SDK erstellt wurde, und Sie können es in Ihrem Zielkatalog.

  • 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.

    UI-Bild, das zeigt, wie die Ziel-Instanz-ID von der URL abgerufen wird.

  • Optional: Wenn Sie Ihre Zielkonfiguration mit einem Beispielprofil testen möchten, das zum API-Aufruf hinzugefügt wurde, verwenden Sie die /sample-profiles -Endpunkt, 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.

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. Siehe Voraussetzungen für weitere Informationen zum Abrufen dieser ID.

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 zusammen mit der Antwort-Payload zurück.

{
   "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 die Segment-ID und die Flusslaufs-ID für jedes aktivierte Segment zurück. Die Anzahl der Aktivierungseinträge (und der zugehörigen generierten Dateien) entspricht der Anzahl der Segmente, die auf der Zielinstanz zugeordnet sind.

Beispiel: Wenn Sie der Zielinstanz zwei Segmente zugeordnet haben, wird die activations -Array enthält zwei Einträge. Jedes aktivierte Segment 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, 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.

Um Ihr Ziel mit benutzerdefinierten, intuitiveren Profildaten zu testen, können Sie die Antwort anpassen, die Sie von der /sample-profiles -Endpunkt mit Werten Ihrer Wahl verwenden und das benutzerdefinierte Profil in die Anfrage an die /testing/destinationInstance -Endpunkt.

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. Siehe Voraussetzungen für weitere Informationen zum Abrufen dieser ID.
profiles Array, das ein oder mehrere Profile enthalten kann. Verwenden Sie die Beispielprofil-API-Endpunkt , um Profile zu generieren, die in diesem API-Aufruf verwendet werden.

Antwort

Eine erfolgreiche Antwort gibt den HTTP-Status 200 zusammen mit der Antwort-Payload zurück.

{
   "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 Gibt die Segment-ID und die Flusslaufs-ID für jedes aktivierte Segment zurück. Die Anzahl der Aktivierungseinträge (und der zugehörigen generierten Dateien) entspricht der Anzahl der Segmente, die auf der Zielinstanz zugeordnet sind.

Beispiel: Wenn Sie der Zielinstanz zwei Segmente zugeordnet haben, wird die activations -Array enthält zwei Einträge. Jedes aktivierte Segment 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, 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

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 results -Eigenschaft aus der Antwort auf detaillierte Aktivierungsergebnisse anzeigen.

Wenn Sie ein öffentliches Ziel erstellen, können Sie jetzt Senden der Zielkonfiguration zur Adobe zur Überprüfung.

Auf dieser Seite