Show Menu
SUJETS×

Catalog Service guide du développeur

Catalog Service est le système d’enregistrement pour l’emplacement et le lignage des données dans l’Adobe Experience Platform. Catalog agit comme un magasin de métadonnées ou un "catalogue" dans lequel vous pouvez trouver des informations sur vos données Experience Platform, sans avoir à accéder aux données proprement dites. Pour plus d’informations, consultez la Présentation du catalogue .
This developer guide provides steps to help you start using the Catalog API. The guide then provides sample API calls for performing key operations using Catalog.

Conditions préalables

Catalog effectue le suivi des métadonnées pour plusieurs types de ressources et d’opérations au sein de Experience Platform. This developer guide requires a working understanding of the various Experience Platform services involved with creating and managing these resources:
  • Experience Data Model (XDM) : Cadre normalisé selon lequel Platform organiser les données d’expérience client.
  • Ingestion par lots Experience Platform : méthode d’ingestion et de stockage de données de fichiers, par exemple de type CSV et Parquet, dans
  • Ingestion par flux Experience Platform : méthode d’ingestion et de stockage de données en temps réel dans à partir de périphériques côté client et côté serveur.
The following sections provide additional information that you will need to know or have on-hand in order to successfully make calls to the Catalog Service API.

Lecture d’exemples d’appels API

Ce guide fournit des exemples d’appels API pour démontrer comment formater vos requêtes. Il s’agit notamment de chemins d’accès, d’en-têtes requis et de payloads de requêtes correctement formatés. L’exemple JSON renvoyé dans les réponses de l’API est également fourni. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.

Collecte des valeurs des en-têtes requis

In order to make calls to Platform APIs, you must first complete the authentication tutorial . 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. All 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}
For more information on sandboxes in Platform, see the sandbox overview documentation .
Toutes les requêtes contenant un payload (POST, PUT, PATCH) requièrent un en-tête supplémentaire :
  • Content-Type: application/json

Best practices for Catalog API calls

When performing GET requests to the Catalog API, best practice is to include query parameters in your requests in order to return only the objects and properties that you need. Les requêtes non filtrées peuvent entraîner des payloads de réponse supérieurs à 3 Go, ce qui peut ralentir les performances globales.
Vous pouvez afficher des objets spécifiques en incluant leurs identifiants dans le chemin d’accès à la requête ou utiliser des paramètres de requête tels que properties et limit pour filtrer les réponses. Les filtres peuvent être transmis sous forme d’en-têtes et de paramètres de requête, les filtres transmis sous forme de paramètres de requête prévalant sur les autres. Pour plus d’informations, consultez le document sur le filtrage des données du catalogue .
Since some queries can put a heavy load on the API, global limits have been implemented on Catalog queries to further support best practices.

Étapes suivantes

This document covered the prerequisite knowledge required to make calls to the Catalog API. Vous pouvez désormais procéder aux appels d’échantillon fournis dans ce guide de développement à suivre avec leurs instructions.
Most of the examples in this guide use the /dataSets endpoint, but the principles can be applied to other endpoints within Catalog (such as /batches and /accounts ). Consultez la référence de l’API Catalog Service pour obtenir une liste complète de tous les appels et opérations disponibles pour chaque point de terminaison.
For a step-by-step workflow that demonstrates how the Catalog API is involved with data ingestion, see the tutorial on creating a dataset .