Guide de l’API Data Access

IMPORTANT
L’API Data Access est désormais obsolète. Il est conseillé d’utiliser des destinations pour exporter des données à partir de Adobe Experience Platform. Pour plus d’informations, reportez-vous à la documentation sur les destinations d’exportation de jeux de données.

L’API Data Access prend en charge Adobe Experience Platform en fournissant aux utilisateurs une interface RESTful axée sur la découverte et l’accessibilité des jeux de données ingérés dans Experience Platform.

Schéma de la manière dont l’accès aux données facilite la découverte et l’accessibilité des jeux de données ingérés dans Experience Platform.

Référence de spécification API

La documentation de référence OpenAPI se trouve ici.

Terminologie terminology

Le tableau fournit une description de certains termes couramment utilisés dans ce document.

Terme
Description
Jeu de données
Collection de données qui comprend un schéma et des champs.
Lot
Un ensemble de données collectées sur une période donnée et traitées ensemble comme une seule unité.

Récupération de la liste de fichiers au sein d’un lot retrieve-list-of-files-in-a-batch

Pour récupérer une liste des fichiers appartenant à un lot spécifique, utilisez l’identifiant de lot (batchID) avec l’API Data Access.

Format d’API

GET /batches/{BATCH_ID}/files
Propriété
Description
{BATCH_ID}
L’identifiant du lot spécifié.

Requête

curl -X GET https://platform.adobe.io/data/foundation/export/batches/{BATCH_ID}/files \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    },
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}

Le tableau "data" contient une liste de tous les fichiers au sein d’un lot spécifique. Chaque fichier renvoyé possède son propre ID unique ({FILE_ID}) contenu dans le champ "dataSetFileId". Vous pouvez utiliser cet identifiant unique pour accéder au fichier ou le télécharger.

Propriété
Description
data.dataSetFileId
L’identifiant de fichier de chaque fichier du lot renseigné.
data._links.self.href
L’URL d’accès au fichier.

Accès et téléchargement de fichiers au sein d’un lot

Pour accéder aux détails spécifiques d’un fichier, utilisez un identifiant de fichier ({FILE_ID}) avec l’API Data Access, notamment son nom, sa taille en octets et un lien à télécharger.

La réponse contient un tableau de données. Selon que le fichier désigné par l’identifiant est un fichier individuel ou un répertoire, le tableau de données renvoyé peut contenir une seule entrée ou une liste de fichiers appartenant à ce répertoire. Chaque élément de fichier inclut les détails du fichier.

Format d’API

GET /files/{FILE_ID}
Propriété
Description
{FILE_ID}
Est égal à "dataSetFileId", l’identifiant du fichier auquel vous essayez d’accéder.

Requête

curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID} \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse de fichier unique

{
  "data": [
    {
      "name": "{FILE_NAME}",
      "length": "{LENGTH}",
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}
Propriété
Description
data.name
Nom du fichier (par exemple, profiles.csv).
data.length
Taille du fichier (en octets).
data._links.self.href
L’URL de téléchargement du fichier.

Réponse du répertoire

{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 2
  }
}

Lorsqu’un répertoire est renvoyé, il contient un tableau de tous les fichiers se trouvant dans le répertoire.

Propriété
Description
data.name
Nom du fichier (par exemple, profiles.csv).
data._links.self.href
L’URL de téléchargement du fichier.

Accès aux contenus d’un fichier access-file-contents

Vous pouvez également utiliser l’API Data Access pour accéder au contenu d’un fichier. Vous pouvez ensuite télécharger le contenu vers une source externe.

Format d’API

GET /files/{dataSetFileId}?path={FILE_NAME}
Propriété
Description
{FILE_NAME}
Le nom du fichier auquel vous essayez d’accéder.

Requête

curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME} \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
Propriété
Description
{FILE_ID}
L’identifiant du fichier au sein d’un jeu de données.
{FILE_NAME}
Nom complet du fichier (par exemple, profiles.csv).

Réponse

Contents of the file

Exemples de code supplémentaires

Pour d’autres exemples, reportez-vous au tutoriel sur l’accès aux données.

Abonnement aux événements d’ingestion de données subscribe-to-data-ingestion-events

Vous pouvez vous abonner à des événements à valeur élevée spécifiques par le biais de Adobe Developer Console. Par exemple, vous pouvez vous abonner aux événements d’ingestion de données pour être informé des retards et des échecs potentiels. Pour plus dʼinformations, consultez le tutoriel sur lʼabonnement aux notifications dʼingestion des données.

recommendation-more-help
d71356da-cd87-452c-8a00-68926401758f