Segmentergebnisse auswerten und darauf zugreifen

Dieses Dokument bietet eine Anleitung zum Evaluieren von Segmenten und zum Zugriff auf Segmentergebnisse mithilfe der -Segmentierungs-API.

Erste Schritte

Dieses Lernprogramm erfordert ein Verständnis der verschiedenen Adobe Experience Platform Dienste, die beim Erstellen von Segmenten für die Audience erforderlich sind. Bevor Sie mit diesem Tutorial beginnen, lesen Sie bitte die Dokumentation für die folgenden Dienste:

  • Echtzeit-Profil: Bietet ein einheitliches, kundenspezifisches Profil in Echtzeit, das auf aggregierten Daten aus mehreren Quellen basiert.
  • Adobe Experience Platform Segmentation Service: Ermöglicht Ihnen das Erstellen von Segmenten für Audiencen aus Real-time Customer Profile Daten.
  • Experience Data Model (XDM): Das standardisierte Framework, mit dem Plattform Kundenerlebnisdaten organisiert.
  • Sandboxen: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Platform Instanz in separate virtuelle Umgebung unterteilen, um Anwendungen für digitale Erlebnisse zu entwickeln und weiterzuentwickeln.

Erforderliche Kopfzeilen

This tutorial also requires you to have completed the authentication tutorial in order to successfully make calls to Platform APIs. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:

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

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:

  • x-sandbox-name: {SANDBOX_NAME}
Hinweis

For more information on sandboxes in Platform, see the sandbox overview documentation.

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.

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 Audience sofort zu erstellen. Die Schritte für die einzelnen Schritte sind nachfolgend beschrieben.

Wenn Sie das Erstellen eines Segments noch nicht mithilfe des Segmentierungs-API -Tutorials abgeschlossen haben oder eine Segmentdefinition mit dem Segmentaufbauerstellt haben, führen Sie dies bitte vor dem Fortfahren dieses Tutorials durch.

Geplante Bewertung

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

Hinweis

Scheduled evaluation can be enabled for sandboxes with a maximum of five (5) merge policies for XDM Individual Profile. If your organization has more than five merge policies for XDM Individual Profile within a single sandbox environment, you will not be able to use scheduled evaluation.

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.

Detailliertere Informationen zur Verwendung dieses Endpunkts finden Sie im Leitfaden zum Endpunkt " 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.

Detailliertere Informationen zur Verwendung dieses Endpunkts finden Sie im Leitfaden zum Endpunkt " Zeitpläne".

Zeitplanaktualisierung

Die Zeitplanung kann aktualisiert werden, indem eine PATCH-Anforderung an den /config/schedules Endpunkt gesendet und die ID des Zeitplans in den Pfad aufgenommen wird.

Detailliertere Informationen zur Verwendung dieses Endpunkts finden Sie im Leitfaden zum Endpunkt " Zeitpläne".

On-Demand-Bewertung

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

Erstellen eines Segmentauftrags

Ein Segmentauftrag ist ein asynchroner Vorgang, bei dem ein neues Zielgruppensegment erstellt wird. It references a segment definition, as well as any merge policies controlling how Real-time Customer Profile merges overlapping attributes across your profile fragments. 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.

You can create a new segment job by making a POST request to the /segment/jobs endpoint in the Real-time Customer Profile API.

Detailliertere Informationen zur Verwendung dieses Endpunkts finden Sie im Handbuch Segmentauftragsendpunkt

Status des Segmentauftrags suchen

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

Detailliertere Informationen zur Verwendung dieses Endpunkts finden Sie im Handbuch Segmentauftragsendpunkt

Segmentergebnisse interpretieren

Wenn Segmentaufträge erfolgreich ausgeführt werden, wird die segmentMembership Zuordnung für jedes Profil im Segment aktualisiert. segmentMembership speichert auch alle vorab ausgewerteten Audiencen, die in eingegliedert werden, Platformsodass eine Integration mit anderen Lösungen wie Adobe Audience Manager.

Das folgende Beispiel zeigt, wie das segmentMembership Attribut für jeden einzelnen Profil-Datensatz 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 Zusicherung der Segmentmitgliedschaft erfolgte und das Profil das Segment ein- oder ausstieg.
status Der Status der Segmentbeteiligung als Teil der aktuellen Anforderung. muss einem der folgenden bekannten Werte entsprechen:
  • existing: Die Entität befindet sich weiterhin im Segment.
  • realized: Entität tritt in das Segment ein.
  • exited: Entität beendet das Segment.

Zugriff auf Segmentergebnisse

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

Die folgenden Abschnitte beschreiben diese Optionen detaillierter.

Profil nachschlagen

Wenn Sie das spezifische Profil kennen, auf das Sie zugreifen möchten, können Sie dies mithilfe der Real-time Customer Profile API tun. Die vollständigen Schritte für den Zugriff auf einzelne Profil finden Sie in der Anleitung zum Zugriff auf Echtzeit-Kundendaten 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:

Zielgruppen-Dataset erstellen

Beim Exportieren einer Audience muss zunächst ein Zielgruppe-Datensatz erstellt werden. Es ist wichtig, dass der Datensatz korrekt konfiguriert wird, 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-Musteranforderung). 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 Vereinigung-Schema ist ein systemgeneriertes, schreibgeschütztes Schema, das die Felder von Schemas, die dieselbe Klasse besitzen, Aggregat gibt, in diesem Fall die XDM-Klasse Individuelles Profil. Weitere Informationen zu Schemas der Vereinigung Ansicht finden Sie im Abschnitt zum Echtzeit-Kundenmanagement im Schema Registry-Entwicklerhandbuch.

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

  • Verwenden von APIs: In den folgenden 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 Schema "Vereinigung"verweist, führen Sie die Schritte im UI-Lernprogramm aus und kehren Sie dann zu diesem Lernprogramm zurück, um mit den Schritten zum Generieren von Profilender Audience fortzufahren.

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

API-Format

POST /dataSets

Anfrage

Mit der folgenden Anforderung wird ein neuer Datensatz erstellt, der 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"
    },
    "fileDescription": {
        "persisted": true,
        "containerFormat": "parquet",
        "format": "parquet"
    }
}'
Eigenschaft Beschreibung
name Ein beschreibender Name für den Datensatz.
schemaRef.id Die ID der Vereinigung-Ansicht (Schema), der der Datensatz zugeordnet werden soll.
fileDescription.persisted Ein boolescher Wert, der bei Festlegung auf truedie Persistenz des Datensatzes in der Ansicht "Vereinigung"ermöglicht.

Antwort

Eine erfolgreiche Antwort gibt ein Array zurück, das die schreibgeschützte, systemgenerierte eindeutige ID des neu erstellten Datensatzes enthält. Für den erfolgreichen Export von Audiencen-Mitgliedern ist eine ordnungsgemäß konfigurierte Dataset-ID erforderlich.

[
  "@/datasets/5b020a27e7040801dedba61b"
] 

Generieren von Profilen für Audiencen-Mitglieder

Sobald Sie über einen Datensatz mit Vereinigung-Speicherung verfügen, können Sie einen Exportauftrag erstellen, um die Audiencen im Datensatz zu erhalten, indem Sie eine Anforderung an den /export/jobs Endpunkt in der Real-time Customer Profile -API stellen und die Dataset-ID sowie die Segmentinformationen für die zu exportierenden Segmente angeben.

Detailliertere Informationen zur Verwendung dieses Endpunkts finden Sie im Handbuch für Exportaufträge

Überwachung des Exportfortschritts

Als Exportauftragsprozess können Sie den Status überwachen, indem Sie eine GET an den /export/jobs Endpunkt anfordern und den Pfad id des Exportauftrags einschließen. Der Exportauftrag ist abgeschlossen, sobald das status Feld den Wert "SUCCEEDED"zurückgibt.

Detailliertere Informationen zur Verwendung dieses Endpunkts finden Sie im Handbuch für Exportaufträge

Nächste Schritte

Sobald der Export erfolgreich abgeschlossen wurde, stehen Ihre Daten im Data Lake In zur Verfügung Experience Platform. Sie können dann mit der -Datenzugriffs-API auf die Daten zugreifen, indem Sie die mit dem Export verknüpften Daten verwenden batchId . Je nach Größe des Segments können die Daten in Blöcken vorliegen und der Stapel kann aus mehreren Dateien bestehen.

Eine schrittweise Anleitung zum Zugriff auf und Herunterladen von Stapeldateien mit der Data Access API finden Sie im Lernprogramm"Datenzugriff".

Sie können auch auf erfolgreich exportierte Segmentdaten zugreifen Adobe Experience Platform Query Service. Mithilfe der Benutzeroberfläche oder RESTful-API können Query Service Sie Abfragen für Daten innerhalb der Data LakeBenutzeroberfläche schreiben, überprüfen und ausführen.

Weitere Informationen zur Abfrage von Audiencen finden Sie in der Dokumentation zum Abfrage Service.

Auf dieser Seite