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 über Ihre Daten in finden können, ohne auf die Daten selbst zugreifen zu müssen.Experience Platform Weitere Informationen finden Sie in der Catalog Übersicht über .

In diesem Entwicklerhandbuch finden Sie Anweisungen, wie Sie mit der Verwendung der Catalog-API beginnen können. Dann bietet das Handbuch Beispiel-API-Aufrufe für die Ausführung wichtiger Vorgänge mithilfe von Catalog.

Voraussetzungen

Catalog verfolgt Metadaten für verschiedene Arten von Ressourcen und Vorgängen in 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 Platform Kundenerlebnisdaten organisiert.
  • Batch-Erfassung Experience Platform: So erfasst und speichert Daten aus Datendateien wie CSV und Parquet.
  • Streaming-Erfassung: So Experience Platform erfasst und speichert Daten von Client- und Server-seitigen Geräten in Echtzeit.

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: {IMS_ORG}

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

Best Practices für API-Aufrufe von Catalog

Bei der Ausführung von GET-Anfragen an die API Catalog empfiehlt es sich, Abfrageparameter in Ihre Anfragen einzubeziehen, 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 Gesamtleistung 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

In diesem Dokument wurden die erforderlichen Kenntnisse zum Aufrufen der Catalog-API behandelt. Sie können nun mit den Beispielaufrufen in diesem Entwicklerhandbuch 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 und /accounts). 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🔗.

Auf dieser Seite