Erstellen eines Segments mithilfe der Segmentation Service-API

Dieses Dokument bietet eine Anleitung zum Entwickeln, Testen, Anzeigen einer Vorschau und Speichern einer Segmentdefinition mithilfe der Adobe Experience Platform Segmentation Service API.

Informationen zum Erstellen von Segmenten mithilfe der Benutzeroberfläche finden Sie in der Segment Builder-Handbuch.

Erste Schritte

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

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um erfolgreich Aufrufe an die Platform APIs.

Lesen von Beispiel-API-Aufrufen

In diesem Tutorial wird anhand von Beispielen für API-Aufrufe die korrekte Formatierung von Anfragen aufgezeigt. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anfrage-Payloads. Außerdem wird ein Beispiel für eine von der API im JSON-Format zurückgegebene Antwort bereitgestellt. Informationen zu den Konventionen, die in der Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zum Lesen von Beispiel-API-Aufrufen im Handbuch zur Fehlerbehebung für Experience Platform

Sammeln von Werten für erforderliche Kopfzeilen

Um Platform-APIs aufzurufen, müssen Sie zunächst das Authentifizierungs-Tutorial abschließen. 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: {ORG_ID}

Alle Ressourcen in Experience Platform sind auf bestimmte virtuelle Sandboxes beschränkt. Bei allen Anfragen an Platform-APIs ist eine Kopfzeile erforderlich, 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.

Bei allen Anfragen mit einer Payload (POST, PUT, PATCH) ist eine zusätzliche Kopfzeile erforderlich:

  • Content-Type: application/json

Entwickeln einer Segmentdefinition

Der erste Schritt bei der Segmentierung besteht darin, ein Segment zu definieren, das in einem Konstrukt dargestellt wird, das als Segmentdefinition bezeichnet wird. Eine Segmentdefinition ist ein Objekt, das eine Abfrage enthält, die in Profile Query Language (PQL). Dieses Objekt wird auch als PQL-Prädikat bezeichnet. PQL-Eigenschaften definieren die Regeln für das Segment basierend auf Bedingungen, die sich auf Datensatz- oder Zeitreihendaten beziehen, die Sie für Real-time Customer Profile. Siehe PQL-Handbuch für weitere Informationen zum Schreiben von PQL-Abfragen.

Sie können eine neue Segmentdefinition erstellen, indem Sie eine POST-Anfrage an die /segment/definitions -Endpunkt im Segmentation API. Im folgenden Beispiel wird beschrieben, wie Sie eine Definitionsanfrage formatieren, einschließlich der Informationen, die erforderlich sind, damit ein Segment erfolgreich definiert werden kann.

Eine ausführliche Erläuterung zur Definition eines Segments finden Sie im Abschnitt Entwicklerhandbuch zur Segmentdefinition.

Schätzen und Anzeigen einer Vorschau einer Zielgruppe

Bei der Entwicklung Ihrer Segmentdefinition können Sie die Tools für die Schätzung und Vorschau in Real-time Customer Profile um Informationen auf Zusammenfassungsebene anzuzeigen, um sicherzustellen, dass Sie die erwartete Zielgruppe isolieren. Schätzungen liefern statistische Informationen über eine Segmentdefinition, z. B. die prognostizierte Zielgruppengröße und das Konfidenzintervall. Vorschau bietet paginierte Listen mit qualifizierten Profilen für eine Segmentdefinition, sodass Sie die Ergebnisse mit dem, was Sie erwarten, vergleichen können.

Durch Schätzung und Vorschau Ihrer Zielgruppe können Sie Ihre PQL-Eigenschaften testen und optimieren, bis sie ein gewünschtes Ergebnis liefern, in dem sie dann in einer aktualisierten Segmentdefinition verwendet werden können.

Es gibt zwei erforderliche Schritte, um eine Vorschau Ihres Segments anzuzeigen oder eine Schätzung davon zu erhalten:

  1. Erstellen eines Vorschauauftrags
  2. Anzeigen von Schätzungen oder Vorschau Verwendung der ID des Vorschauauftrags

Erstellung von Schätzungen

Datenbeispiele werden verwendet, um Segmente zu bewerten und die Anzahl der qualifizierten Profile zu schätzen. Jeden Morgen werden neue Daten in den Speicher geladen (zwischen 12:00 und 2:00 Uhr PT, was 7:00 Uhr UTC entspricht) und alle Segmentierungsabfragen werden anhand der Beispieldaten dieses Tages geschätzt. Folglich werden alle neuen hinzugefügten Felder oder erfassten zusätzlichen Daten am folgenden Tag in Schätzungen übernommen.

Die Stichprobengröße hängt von der Gesamtanzahl der Entitäten in Ihrem Profilspeicher ab. Diese Stichprobengrößen werden in der folgenden Tabelle dargestellt:

Entitäten im Profilspeicher Stichprobengröße
Weniger als 1 Million Vollständiger Datensatz
1 bis 20 Mio. 1 Mio.
Über 20 Millionen 5 % des Gesamtbetrags

Schätzungen laufen in der Regel über 10-15 Sekunden, beginnend mit einer groben Schätzung und verfeinern, sobald mehr Datensätze gelesen werden.

Erstellen eines Vorschauauftrags

Sie können einen neuen Vorschauauftrag erstellen, indem Sie eine POST-Anfrage an die /preview -Endpunkt.

Detaillierte Anweisungen zum Erstellen eines Vorschauauftrags finden Sie im Handbuch zu Vorschau- und Schätzendpunkten.

Anzeigen einer Schätzung oder Vorschau

Schätzungs- und Vorschauprozesse werden asynchron ausgeführt, da unterschiedliche Abfragen unterschiedliche Zeiträume in Anspruch nehmen können. Nachdem eine Abfrage initiiert wurde, können Sie API-Aufrufe verwenden, um den aktuellen Status der Schätzung oder Vorschau während des Vorgangs abzurufen (GET).

Verwenden der Segmentation Service API können Sie den aktuellen Status eines Vorschauauftrags anhand seiner Kennung nachschlagen. Wenn der Status "RESULT_READY"lautet, können Sie die Ergebnisse anzeigen. Informationen zum aktuellen Status eines Vorschauauftrags finden Sie im Abschnitt unter Abrufen eines Vorschauauftragsabschnitts im Handbuch zu Vorschau- und Schätzungen-Endpunkten. Um den aktuellen Status eines Schätzauftrags zu ermitteln, lesen Sie bitte den Abschnitt unter Abrufen eines Schätzauftrags im Handbuch zu Vorschau- und Schätzungen-Endpunkten.

Nächste Schritte

Nachdem Sie Ihre Segmentdefinition entwickelt, getestet und gespeichert haben, können Sie einen Segmentauftrag erstellen, um eine Zielgruppe mithilfe der Segmentation Service API. Siehe Tutorial zu Segmentergebnisse bewerten und aufrufen für detaillierte Schritte, wie Sie dies erreichen können.

Auf dieser Seite