Segmentergebnisse auswerten und aufrufen

Dieses Dokument bietet eine Anleitung zum Auswerten von Segmenten und Aufrufen von Segmentergebnissen mithilfe von Segmentation API.

Erste Schritte

Dieses Tutorial setzt ein grundlegendes Verständnis der verschiedenen Adobe Experience Platform-Dienste voraus, die am Erstellen von Zielgruppensegmenten beteiligt sind. Bevor Sie mit diesem Tutorial beginnen, lesen Sie bitte die Dokumentation für die folgenden Dienste:

  • Real-time Customer Profile: Bietet ein einheitliches Kundenprofil in Echtzeit, das auf aggregierten Daten aus mehreren Quellen basiert.
  • Adobe Experience Platform Segmentation Service: Ermöglicht das Erstellen von Zielgruppensegmenten anhand von Real-time Customer Profile Daten.
  • Experience Data Model (XDM): Das standardisierte Framework, mit dem Platform Kundenerlebnisdaten organisiert.
  • 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 das Authentifizierungs-Tutorial abgeschlossen haben, damit Sie erfolgreich Aufrufe an Platform-APIs durchführen können. 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 eine Kopfzeile, die den Namen der Sandbox angibt, in der der Vorgang ausgeführt werden soll:

  • 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-Anfragen ist eine zusätzliche Kopfzeile 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.

Die geplante Auswertung (auch als "geplante Segmentierung"bezeichnet) ermöglicht es Ihnen, einen wiederkehrenden Zeitplan für die Ausführung eines Exportauftrags zu einem bestimmten Zeitpunkt zu erstellen, während bei der On-Demand- Auswertung ein Segmentauftrag erstellt werden muss, um die Zielgruppe sofort zu erstellen. Die Schritte für die einzelnen Schritte sind unten beschrieben.

Wenn Sie das Tutorial Erstellen eines Segments mithilfe der Segmentation API noch nicht abgeschlossen haben oder eine Segmentdefinition mit Segment Builder erstellt haben, führen Sie dies vor dem Fortfahren mit diesem Tutorial durch.

Geplante Auswertung

Durch die geplante Auswertung kann Ihre IMS-Organisation einen wiederkehrenden Zeitplan erstellen, um Exportaufträge automatisch auszuführen.

HINWEIS

Geplante Auswertung kann für Sandboxes mit maximal fünf (5) Zusammenführungsrichtlinien für XDM Individual Profile aktiviert werden. Wenn Ihr Unternehmen innerhalb einer Sandbox-Umgebung über mehr als fünf Zusammenführungsrichtlinien für XDM Individual Profile verfügt, können Sie keine geplante Auswertung 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.

Weitere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunktleitfaden für Zeitpläne .

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.

Weitere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunktleitfaden für Zeitpläne .

Zeitplanaktualisierung

Der Zeitplan-Timing kann aktualisiert werden, indem eine PATCH-Anfrage an den Endpunkt /config/schedules gesendet wird und die Kennung des Zeitplans in den Pfad aufgenommen wird.

Weitere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunktleitfaden für Zeitpläne .

On-Demand-Evaluierung

Mit der On-Demand-Auswertung können Sie einen Segmentauftrag erstellen, um bei Bedarf ein Zielgruppensegment zu generieren. Im Gegensatz zur geplanten Auswertung erfolgt dies nur bei Anforderung und nicht wiederholt.

Erstellen eines Segmentauftrags

Ein Segmentauftrag ist ein asynchroner Vorgang, bei dem ein neues Zielgruppensegment erstellt wird. Er verweist auf eine Segmentdefinition sowie auf alle Zusammenführungsrichtlinien, die steuern, wie Real-time Customer Profile überlappende Attribute über Ihre Profilfragmente hinweg zusammenführt. 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-Anfrage an den Endpunkt /segment/jobs in der API Real-time Customer Profile stellen.

Weitere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunktleitfaden für Segmentaufträge .

Status des Segmentauftrags nachschlagen

Sie können den id für einen bestimmten Segmentauftrag verwenden, um eine Suchanfrage (GET) auszuführen, um den aktuellen Status des Auftrags anzuzeigen.

Weitere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunktleitfaden für Segmentaufträge .

Interpretieren von Segmentergebnissen

Wenn Segmentaufträge erfolgreich ausgeführt werden, wird die Zuordnung segmentMembership für jedes Profil aktualisiert, das im Segment enthalten ist. segmentMembership speichert auch alle vorab ausgewerteten Zielgruppensegmente, die in aufgenommen werden, Platformsodass sie mit anderen Lösungen wie Adobe Audience Manager integriert werden können.

Das folgende Beispiel zeigt, wie das segmentMembership-Attribut für jeden einzelnen Profildatensatz aussieht:

{
  "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, zu dem die Bestätigung der Segmentzugehörigkeit erfolgte und das Profil in das Segment eintrat oder es verließ.
status Der Status der Segmentbeteiligung als Teil der aktuellen Anfrage. Muss einem der folgenden bekannten Werte entsprechen:
  • existing: Die Entität befindet sich weiterhin im Segment.
  • realized: Entität gibt das Segment ein.
  • exited: Entität beendet das Segment.

Auf Segmentergebnisse zugreifen

Auf die Ergebnisse eines Segmentauftrags kann auf zwei Arten zugegriffen werden: Sie können auf einzelne Profile zugreifen oder eine gesamte Zielgruppe in einen Datensatz exportieren.

In den folgenden Abschnitten werden diese Optionen ausführlicher beschrieben.

Profil nachschlagen

Wenn Sie das spezifische Profil kennen, auf das Sie zugreifen möchten, können Sie dies mit der API Real-time Customer Profile tun. Die vollständigen Schritte zum Zugriff auf einzelne Profile finden Sie im Tutorial Zugriff auf Echtzeit-Kundenprofil-Daten mithilfe der Profil-API .

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:

Zieldatensatz erstellen

Beim Exportieren einer Zielgruppe muss zunächst ein Zieldatensatz erstellt werden. Es ist wichtig, dass der Datensatz korrekt konfiguriert ist, um sicherzustellen, dass der Export erfolgreich ist.

Eine der wichtigsten Überlegungen ist das Schema, auf dem der Datensatz basiert (schemaRef.id in der unten stehenden API-Beispielanfrage). Um ein Segment zu exportieren, muss der Datensatz auf dem XDM Individual Profile Union Schema (https://ns.adobe.com/xdm/context/profile__union) basieren. Ein Vereinigungsschema ist ein systemgeneriertes, schreibgeschütztes Schema, das die Felder von Schemas aggregiert, die dieselbe Klasse teilen, in diesem Fall die Klasse "XDM Individual Profile". Weitere Informationen zu Vereinigungsansichtsschemas finden Sie im Abschnitt Echtzeit-Kundenprofil des Entwicklerhandbuchs zur Schema Registry.

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

  • Verwenden von APIs: In den in diesem Tutorial beschriebenen Schritten wird beschrieben, wie Sie einen Datensatz erstellen, der auf die XDM Individual Profile Union Schema mithilfe der Catalog API verweist.
  • Verwenden der Benutzeroberfläche: Um mithilfe der Adobe Experience Platform Benutzeroberfläche einen Datensatz zu erstellen, der auf das Vereinigungsschema verweist, führen Sie die Schritte im UI- Tutorial aus und kehren Sie dann zu diesem Tutorial zurück, um mit den Schritten zum Generieren von Zielgruppenprofilen fortzufahren.

Wenn Sie bereits über einen kompatiblen Datensatz verfügen und dessen Kennung kennen, können Sie direkt mit dem Schritt zum Generieren von Zielgruppenprofilen🔗 fortfahren.

API-Format

POST /dataSets

Anfrage

Die folgende Anfrage erstellt einen neuen Datensatz und stellt Konfigurationsparameter in der Payload bereit.

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 Ein beschreibender Name für den Datensatz.
schemaRef.id Die ID der Vereinigungsansicht (Schema), mit der der Datensatz verknüpft wird.

Antwort

Eine erfolgreiche Antwort gibt ein Array zurück, das die schreibgeschützte, systemgenerierte eindeutige ID des neu erstellten Datensatzes enthält. Eine ordnungsgemäß konfigurierte Datensatz-ID ist erforderlich, um Audience-Mitglieder erfolgreich zu exportieren.

[
  "@/datasets/5b020a27e7040801dedba61b"
] 

Generieren von Profilen für Zielgruppenmitglieder

Sobald Sie über einen Datensatz mit Vereinigungspersistenz verfügen, können Sie einen Exportauftrag erstellen, um die Mitglieder der Zielgruppe im Datensatz zu erhalten, indem Sie eine POST-Anfrage an den Endpunkt /export/jobs in der API Real-time Customer Profile senden und die Datensatz-ID sowie die Segmentinformationen für die Segmente angeben, die exportiert werden sollen.

Ausführlichere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunktleitfaden für Exportaufträge .

Fortschritt des Exports überwachen

Bei Exportvorgängen können Sie den Status überwachen, indem Sie eine GET-Anfrage an den Endpunkt /export/jobs senden und die id des Exportauftrags in den Pfad einschließen. Der Exportauftrag ist abgeschlossen, sobald das Feld status den Wert "SUCCEEDED"zurückgibt.

Ausführlichere Informationen zur Verwendung dieses Endpunkts finden Sie im Endpunktleitfaden für Exportaufträge .

Nächste Schritte

Nach erfolgreichem Abschluss des Exports sind Ihre Daten im Ordner Data Lake in Experience Platform verfügbar. Sie können dann Data Access API verwenden, um mit dem mit dem Export verknüpften batchId auf die Daten zuzugreifen. Je nach Größe des Segments können die Daten in Blöcken vorliegen und der Batch kann aus mehreren Dateien bestehen.

Eine schrittweise Anleitung zum Verwenden der Data Access-API für den Zugriff auf und den Download von Batch-Dateien finden Sie im Tutorial zum Datenzugriff.

Sie können auch mit Adobe Experience Platform Query Service auf erfolgreich exportierte Segmentdaten zugreifen. Mithilfe der Benutzeroberfläche oder der RESTful-API können Sie mit Query Service Abfragen zu Daten in Data Lake schreiben, validieren und ausführen.

Weiterführende Informationen zur Abfrage von Zielgruppendaten finden Sie in der Dokumentation zu Query Service.

Auf dieser Seite