Catalog Service-API-Handbuch
Catalog Service ist ein Aufzeichnungssystem für Speicherort und Herkunft von Daten in Adobe Experience Platform. Catalog dient als Metadatenspeicher oder "Katalog", in dem Sie Informationen zu Ihren Daten innerhalb von Experience Platform finden können, ohne auf die Daten selbst zugreifen zu müssen. Weitere Informationen finden Sie in der Catalog Übersicht.
In diesem Entwicklerhandbuch finden Sie Anweisungen, wie Sie mit der Verwendung der Catalog-API beginnen können. Das Handbuch enthält dann Beispiel-API-Aufrufe für die Ausführung wichtiger Vorgänge mit Catalog.
Voraussetzungen
Catalog verfolgt Metadaten für verschiedene Arten von Ressourcen und Vorgängen innerhalb von Experience Platform. Dieses Entwicklerhandbuch setzt ein Verständnis der verschiedenen Experience Platform-Dienste voraus, die mit der Erstellung und Verwaltung dieser Ressourcen verbunden sind:
- Experience Data Model (XDM): Das standardisierte Framework, mit dem Kundenerlebnisdaten von Platform organisiert werden.
- Batch-Erfassung: Wie Experience Platform Daten aus Datendateien wie CSV und Parquet erfasst und speichert.
- Streaming-Erfassung: Wie Experience Platform Daten von Client- und Server-seitigen Geräten in Echtzeit erfasst und speichert.
Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um die Catalog Service -API erfolgreich aufrufen zu können.
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 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}
Bei allen Anfragen mit einer Payload (POST, PUT, PATCH) ist eine zusätzliche Kopfzeile erforderlich:
- Content-Type: application/json
Best Practices für Catalog API-Aufrufe
Bei der Durchführung von GET-Anfragen an die Catalog -API ist es Best Practice, Abfrageparameter in Ihre Anfragen aufzunehmen, um nur die benötigten Objekte und Eigenschaften zurückzugeben. Ungefilterte Anfragen können dazu führen, dass Antwort-Payloads größer als 3 GB sind, was die Gesamt-Performance verringern kann.
Außerdem können Sie bestimmte Objekte durch Einfügen ihrer Kennung in den Anfragepfad anzeigen oder Abfrageparameter wie properties und limit zum Filtern von Antworten verwenden. Filter können als Kopfzeilen und Abfrageparameter übergeben werden, wobei Abfrageparameter bei der Übergabe Vorrang erhalten. Weiterführende Informationen finden Sie im Dokument zum Filtern von Catalog-Daten.
Da einige Abfragen die API stark belasten können, wurden globale Beschränkungen für Catalog-Abfragen implementiert, um Best Practices weiter zu unterstützen.
Nächste Schritte
Dieses Dokument behandelt die erforderlichen Grundkenntnisse zum Aufrufen der Catalog-API. Sie können nun mit den Beispielaufrufen in diesem Entwicklungshandbuch fortfahren und den entsprechenden Anweisungen folgen.
Die meisten Beispiele in diesem Handbuch verwenden den Endpunkt /dataSets , die Prinzipien können jedoch auf andere Endpunkte innerhalb von Catalog angewendet werden (z. B. /batches). Eine vollständige Liste aller bei einzelnen Endpunkten verfügbaren Aufrufe und Vorgänge finden Sie in der Referenz zur Catalog Service-API.
Einen schrittweisen Workflow, der zeigt, wie die Catalog-API an der Datenerfassung beteiligt ist, finden Sie im Tutorial zum Erstellen eines Datensatzes .