DokumentationExperience PlatformZielhandbuch

Generieren von Beispielprofilen basierend auf einem Quellschema

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

Erstellt für:

  • Admin
  • Benutzende

Der erste Schritt beim Testen Ihres dateibasierten Ziels besteht darin, den Endpunkt /sample-profiles zu verwenden, um ein Beispielprofil zu generieren, das auf Ihrem vorhandenen Quellschema basiert.

Beispielprofile können Ihnen dabei helfen, die JSON-Struktur eines Profils zu verstehen. Darüber hinaus erhalten Sie eine Standardeinstellung, die Sie mit Ihren eigenen Profildaten anpassen können, um weitere Zieltests durchzuführen.

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 /sample-profiles 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. Der Endpunkt /sample-profiles erstellt die Profile basierend auf dem Quellschema, das Sie in Ihrem Aktivierungsablauf definiert haben. Im Aktivierungs-Tutorial erfahren Sie, wie Sie einen Aktivierungsfluss erstellen.

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

Generieren von Beispielprofilen für Zieltests generate-sample-profiles

Sie können Beispielprofile basierend auf Ihrem Quellschema generieren, indem Sie eine GET-Anfrage an den Endpunkt /sample-profiles mit der Ziel-Instanz-ID des Ziels stellen, das Sie testen möchten.

API-Format

GET /authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={NUMBER_OF_GENERATED_PROFILES}
Abfrageparameter
Beschreibung
destinationInstanceId
Die ID der Zielinstanz, für die Sie Beispielprofile generieren. Im Abschnitt Voraussetzungen finden Sie weitere Informationen zum Abrufen dieser ID.
count
Optional. Die Anzahl der Beispielprofile, die Sie generieren möchten. Der Parameter kann Werte von 1 - 1000 annehmen. Wenn diese Eigenschaft nicht definiert ist, generiert die API ein einzelnes Beispielprofil.

Anfrage

Die folgende Anfrage generiert ein Beispielprofil basierend auf dem in der Zielinstanz definierten Quellschema mit der entsprechenden destinationInstanceId.

curl -X GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId={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}' \

Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit der angegebenen Anzahl von Beispielprofilen zurückgegeben, mit Zielgruppenmitgliedschaft, Identitäten und Profilattributen, die dem Quell-XDM-Schema entsprechen.

NOTE
Die Antwort gibt nur Zielgruppenmitgliedschaften, Identitäten und Profilattribute zurück, die in der Zielinstanz verwendet werden. Selbst wenn Ihr Quellschema andere Felder enthält, werden diese ignoriert.
[
   {
      "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"
         }
      }
   }
]

Bild, das die Zuordnung von der Benutzeroberfläche zu den Feldern aus der API-Antwort anzeigt.

Eigenschaft
Beschreibung
segmentMembership
Ein Zuordnungsobjekt, das die Zielgruppenmitgliedschaften der Person beschreibt. Weitere Informationen zu segmentMembership finden Sie unter Details zur Zielgruppenmitgliedschaft.
lastQualificationTime
Ein Zeitstempel, der angibt, wann sich dieses Profil zuletzt für das Segment qualifiziert hat.
status

Ein Zeichenfolgenfeld, das angibt, ob die Zielgruppenmitgliedschaft im Rahmen der aktuellen Anfrage realisiert wurde. Folgende Werte werden akzeptiert:

  • realized: Das Profil ist Teil des Segments.
  • exited: Das Profil verlässt die Zielgruppe im Rahmen der aktuellen Anfrage.
identityMap
Ein Feld vom Typ „Zuordnung“, das die verschiedenen Identitätswerte einer Person zusammen mit den zugehörigen Namespaces beschreibt. Weitere Informationen zu identityMap finden Sie unter Grundlage der Schemakomposition.

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 Beispielprofile basierend auf dem Quellschema generieren, das Sie in Ihrem Zielaktivierungsfluss konfiguriert haben.

Sie können diese Profile jetzt anpassen oder so verwenden, wie sie von der API zurückgegeben werden, um die dateibasierte Zielkonfiguration zu testen.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6