Query Service-API-Handbuch

Dieses Entwicklerhandbuch enthält Schritte zum Ausführen verschiedener Vorgänge in Adobe Experience Platform Query Service API.

Erste Schritte

Dieses Handbuch setzt ein Verständnis der verschiedenen Adobe Experience Platform-Dienste voraus, die mit der Verwendung von Query Service.

Query Service: Bietet die Möglichkeit, Datensätze abzufragen und die resultierenden Abfragen als neue Datensätze in Experience Platform.
Experience Data Model (XDM) System: Das standardisierte Framework, mit dem Kundenerlebnisdaten von Experience Platform organisiert werden.
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.

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um erfolgreich verwenden zu können Query Service die API verwenden.

Lesen von Beispiel-API-Aufrufen

In diesem Handbuch 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 dieser Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zu So lesen Sie Beispiel-API-Aufrufe im Experience Platform Handbuch zur Fehlerbehebung.

Sammeln von Werten für erforderliche Kopfzeilen

Um Experience 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 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. Alle Anfragen 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 zum Arbeiten mit Sandboxes finden Sie unter Experience Platform, siehe Sandbox-Übersichtsdokumentation.

Beispiel-API-Aufrufe

Nachdem Sie nun wissen, welche Header verwendet werden sollen, können Sie mit den Aufrufen an die Query Service API. In den folgenden Dokumenten werden die verschiedenen API-Aufrufe erläutert, die Sie mithilfe der Query Service API. Jeder Beispielaufruf enthält das allgemeine API-Format, eine Beispielanfrage mit den erforderlichen Kopfzeilen und eine Beispielantwort.

Nächste Schritte

Nachdem Sie nun gelernt haben, wie Sie Aufrufe mit dem Query Service API können Sie Ihre eigenen nicht interaktiven Abfragen erstellen. Weitere Informationen zum Erstellen von Abfragen finden Sie im Abschnitt SQL-Referenzhandbuch.