Segmentergebnisse bewerten und darauf zugreifen

Dieses Dokument bietet einen Lehrgang zum Auswerten von Segmenten und zum Zugriff auf Segmentergebnisse mithilfe der Segmentation API.

Erste Schritte

Dieses Tutorial erfordert ein Verständnis der verschiedenen Adobe Experience Platform Dienste, die mit der Erstellung von Audiencen-Segmenten verbunden sind. Bevor Sie mit diesem Tutorial beginnen, lesen Sie bitte die Dokumentation für die folgenden Dienste:

  • Real-time Customer Profile: Provides a unified, customer profile in real time based on aggregated data from multiple sources.
  • Adobe Experience Platform Segmentation Service: Ermöglicht es Ihnen, Audiencen-Segmente zu erstellen von Real-time Customer Profile Daten.
  • Experience Data Model (XDM): Das standardisierte Framework, mit dem Platform Kundenerlebnisdaten organisiert. Um die Segmentierung optimal zu nutzen, stellen Sie sicher, dass Ihre Daten als Profil und Ereignis gemäß der Best Practices für die Datenmodellierung.
  • Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse entwickeln und weiterentwickeln können.

Erforderliche Kopfzeilen

Für dieses Tutorial müssen Sie außerdem die Authentifizierungslehrgang , um erfolgreich Aufrufe von Platform APIs. Durch Abschluss des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Header in allen Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Alle Ressourcen in Experience Platform sind auf bestimmte virtuelle Sandboxes beschränkt. Anforderungen an Platform APIs erfordern einen Header, der den Namen der Sandbox angibt, in der der Vorgang stattfinden soll in:

  • x-sandbox-name: {SANDBOX_NAME}
HINWEIS

Weitere Informationen zu Sandboxes in Platform finden Sie in der Sandbox-Übersichtsdokumentation.

Für alle POST-, PUT- und PATCH-Anforderungen ist ein zusätzlicher Header erforderlich:

  • Content-Type: application/json

Bewerten eines Segments

Nachdem Sie Ihre Segmentdefinition entwickelt, getestet und gespeichert haben, können Sie das Segment entweder durch eine geplante Auswertung oder eine On-Demand-Auswertung bewerten.

Geplante Evaluierung (auch als "geplante Segmentierung" bekannt) ermöglicht es Ihnen, einen wiederholten Zeitplan für die Ausführung eines Exportauftrags zu einem bestimmten Zeitpunkt zu erstellen. Bedarfsorientierte Bewertung umfasst die Erstellung eines Segmentauftrags, um die Audience sofort zu erstellen. Die einzelnen Schritte sind nachstehend beschrieben.

If you have not yet completed the create a segment using the Segmentation API tutorial or created a segment definition using Segment Builder, please do so before proceeding with this tutorial.

Scheduled evaluation

Through scheduled evaluation, your IMS Org can create a recurring schedule to automatically run export jobs.

HINWEIS

Die geplante Evaluierung kann für Sandboxen mit maximal fünf (5) Zusammenführungsrichtlinien aktiviert werden für XDM Individual Profile. Wenn Ihr Unternehmen mehr als fünf Zusammenführungsrichtlinien für XDM Individual Profile innerhalb einer einzigen Sandbox-Umgebung können Sie keine geplante Evaluierung verwenden.

Zeitplan erstellen

Wenn Sie eine POST-Anfrage an den /config/schedules-Endpunkt senden, können Sie einen Zeitplan erstellen und die genaue Zeit einschließen, zu der der Zeitplan ausgelöst werden soll.

Ausführlichere Informationen zur Verwendung dieses Endpunkts finden Sie im Zeitplanendpunkt-Handbuch

Zeitplan aktivieren

Standardmäßig ist ein Zeitplan bei der Erstellung inaktiv, es sei denn, die state-Eigenschaft ist im Text der POST-Anfrage (Erstellen) auf active gesetzt. Sie können einen Zeitplan aktivieren (setzen Sie state auf active), indem Sie eine PATCH-Anfrage an den /config/schedules-Endpunkt senden und die Kennung des Zeitplans in den Pfad einschließen.

Ausführlichere Informationen zur Verwendung dieses Endpunkts finden Sie im Zeitplanendpunkt-Handbuch

Planungszeit aktualisieren

Der Zeitplan kann aktualisiert werden, indem Sie eine PATCH an die folgende Stelle senden: /config/schedules Endpunkt und einschließlich der ID des Zeitplans im Pfad.

Ausführlichere Informationen zur Verwendung dieses Endpunkts finden Sie im Zeitplanendpunkt-Handbuch

Bedarfsorientierte Bewertung

Mit der Bedarfsanalyse können Sie einen Segmentauftrag erstellen, um ein Audience-Segment zu generieren, wann immer Sie es benötigen. Unlike scheduled evaluation, this will happen only when requested and is not recurring.

Segmentauftrag erstellen

Ein Segmentauftrag ist ein asynchroner Vorgang, bei dem ein neues Zielgruppensegment erstellt wird. Es verweist auf eine Segmentdefinition sowie auf alle Zusammenführungsrichtlinien, die bestimmen, wie Real-time Customer Profile Führt überlappende Attribute in Ihren Profil-Fragmenten zusammen. Nach erfolgreichem Abschluss eines Segmentauftrags können Sie verschiedene Informationen über das Segment sammeln, z. B. Fehler, die bei der Verarbeitung aufgetreten sind, oder die endgültige Größe Ihrer Zielgruppe.

Sie können einen neuen Segmentauftrag erstellen, indem Sie eine POST anfordern an die /segment/jobs Endpunkt im Real-time Customer Profile API.

Ausführlichere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunkt für Segmentaufträge

Segmentauftragsstatus nachschlagen

Sie können id für einen bestimmten Segmentauftrag, um eine Suchanfrage (GET) auszuführen, um den aktuellen Auftragsstatus Ansicht.

Ausführlichere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunkt für Segmentaufträge

Segmentergebnisse interpretieren

Wenn Segmentaufträge erfolgreich ausgeführt werden, segmentMembership Karte wird für jedes Profil im Segment aktualisiert. segmentMembership speichert auch alle vorausgewerteten Segmente der Audience, die in Platform, die Integration in andere Lösungen wie Adobe Audience Manager.

Das folgende Beispiel zeigt Folgendes: segmentMembership Attribut sieht für jeden einzelnen Profil-Datensatz aus:

{
  "segmentMembership": {
    "UPS": {
      "04a81716-43d6-4e7a-a49c-f1d8b3129ba9": {
        "timestamp": "2018-04-26T15:52:25+00:00",
        "status": "existing"
      },
      "53cba6b2-a23b-454a-8069-fc41308f1c0f": {
        "lastQualificationTime": "2018-04-26T15:52:25+00:00",
        "status": "realized"
      }
    },
    "Email": {
      "abcd@adobe.com": {
        "lastQualificationTime": "2017-09-26T15:52:25+00:00",
        "status": "exited"
      }
    }
  }
}
Eigenschaft Beschreibung
lastQualificationTime Der Zeitstempel, mit dem die Segmentmitgliedschaft bestätigt wurde und das Profil das Segment ein- oder ausstieg.
status Der Status der Segmentbeteiligung als Teil der aktuellen Anforderung. muss gleich einem der folgenden bekannten Werte sein:
  • existing: Entität befindet sich weiterhin im Segment.
  • realized: Entität tritt in das Segment ein.
  • exited: Entität verlässt das Segment.

Segmentergebnisse

Auf die Ergebnisse eines Segmentauftrags kann auf zwei Arten zugegriffen werden: Sie können auf einzelne Profil zugreifen oder eine ganze Audience in ein Dataset exportieren.

In den folgenden Abschnitten werden diese Optionen detaillierter beschrieben.

Profil nachschlagen

If you know the specific profile that you would like to access, you can do so using the Real-time Customer Profile API. Die vollständigen Schritte für den Zugriff auf einzelne Profil finden Sie im Zugriff auf Echtzeit-Kundendaten mithilfe der Profil-API Tutorial.

Segment exportieren

Nachdem ein Segmentierungsauftrag erfolgreich abgeschlossen wurde (der Wert des status-Attributs lautet „SUCCEEDED“ (GELUNGEN)), können Sie Ihre Zielgruppe in einen Datensatz exportieren. In diesem Datensatz ist die Zielgruppe zugänglich und bearbeitbar.

Die folgenden Schritte sind erforderlich, um Ihre Audience zu exportieren:

Zielgruppe-Dataset erstellen

Beim Exportieren einer Audience muss zunächst ein Dataset der Zielgruppe erstellt werden. Es ist wichtig, dass der Datensatz korrekt konfiguriert wird, damit der Export erfolgreich ist.

Eine der wichtigsten Erwägungen ist das Schema, auf dem der Datensatz basiert (schemaRef.id in der API-Beispielanforderung unten). Um ein Segment zu exportieren, muss der Datensatz auf XDM Individual Profile Union Schema (https://ns.adobe.com/xdm/context/profile__union). Ein Vereinigung-Schema ist ein vom System generiertes, schreibgeschütztes Schema, das die Felder von Schemas mit derselben Klasse Aggregat, in diesem Fall die XDM Individual Profil-Klasse. Weitere Informationen zu Schemas der Ansicht der Vereinigung finden Sie im Echtzeitabschnitt zum Kunden-Profil im Schema Registry-Entwicklerleitfaden.

Es gibt zwei Möglichkeiten, den erforderlichen Datensatz zu erstellen:

  • Verwenden von APIs: In diesem Tutorial wird beschrieben, wie Sie ein Dataset erstellen, das auf die XDM Individual Profile Union Schema mit Catalog API.
  • Verwenden der Benutzeroberfläche: So verwenden Sie Adobe Experience Platform Benutzerschnittstelle zum Erstellen eines Datasets, das auf das Schema der Vereinigung verweist, führen Sie die folgenden Schritte aus: UI-Tutorial und kehren dann zu diesem Tutorial zurück, um mit den Schritten für Audience-Profil werden erstellt.

Wenn Sie bereits über ein kompatibles DataSet verfügen und dessen ID kennen, können Sie direkt zum Schritt wechseln für Audience-Profil werden erstellt.

API-Format

POST /dataSets

Anfrage

Mit der folgenden Anforderung wird ein neues DataSet erstellt, das Konfigurationsparameter in der Nutzlast bereitstellt.

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "name": "Segment Export",
    "schemaRef": {
        "id": "https://ns.adobe.com/xdm/context/profile__union",
        "contentType": "application/vnd.adobe.xed+json;version=1"
    }
}'
Eigenschaft Beschreibung
name A descriptive name for the dataset.
schemaRef.id Die ID der Vereinigung-Ansicht (Schema), der das Dataset zugeordnet werden soll.

Antwort

Eine erfolgreiche Antwort gibt ein Array mit der schreibgeschützten, systemgenerierten eindeutigen ID des neu erstellten Datensatzes zurück. Eine ordnungsgemäß konfigurierte DataSet-ID ist erforderlich, um Audiencen erfolgreich exportieren zu können.

[
  "@/datasets/5b020a27e7040801dedba61b"
] 

Profil für Audience-Mitglieder generieren

Sobald Sie über ein Vereinigung persistierendes Dataset verfügen, können Sie einen Exportauftrag erstellen, um die Mitglieder der Audience im Dataset zu behalten, indem Sie eine POST an den /export/jobs Endpunkt im Real-time Customer Profile API und geben die DataSet-ID und die Segmentinformationen für die Segmente an, die Sie exportieren möchten.

Ausführlichere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunkt-Handbuch für Exportaufträge

Fortschritt beim Exportieren überwachen

Bei einem Exportauftrag können Sie den Status überwachen, indem Sie eine GET an die /export/jobs Endpunkt und einschließlich id des Exportauftrags im Pfad. Der Exportauftrag wurde abgeschlossen, sobald der status gibt den Wert "ERFOLGREICH" zurück.

Ausführlichere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunkt-Handbuch für Exportaufträge

Nächste Schritte

Once the export has completed successfully, your data is available within the Data Lake in Experience Platform. Sie können dann Data Access API um auf die Daten zuzugreifen, indem batchId mit dem Export verbunden. Depending on the size of the segment, the data may be in chunks and the batch may consist of several files.

For step-by-step instructions on how to use the Data Access API to access and download batch files, follow the Data Access tutorial.

You can also access successfully exported segment data using Adobe Experience Platform Query Service. Using the UI or RESTful API, Query Service allows you to write, validate, and run queries on data within the Data Lake.

Weitere Informationen zur Abfrage von Daten zur Audience finden Sie in der Dokumentation zu Query Service.

Auf dieser Seite