Guide de l’API Data Access

Dernière mise à jour : 6 mars 2025

Créé pour :

  • Développeur
IMPORTANT
L’API Data Access est désormais obsolète. Il est conseillé d’utiliser Destinations pour exporter des données à partir de Adobe Experience Platform. Pour plus d’informations, reportez-vous à la documentation 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 capacité de 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 capacité de découverte et l’accessibilité des jeux de données ingérés dans Experience Platform.

Référence de spécification API

Reportez-vous à la documentation de référence OpenAPI Data Access pour afficher un format normalisé et lisible par machine afin de faciliter l’intégration, les tests et l’exploration.

Terminologie

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

TermeDescription
Jeu de donnéesUne collection de données qui comprend un schéma et des champs.
LotUn 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

Pour récupérer une liste de fichiers appartenant à un lot particulier, utilisez l’identifiant du 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 ID unique pour accéder au fichier ou le télécharger.

PropriétéDescription
data.dataSetFileIdL’identifiant de fichier de chaque fichier du lot renseigné.
data._links.self.hrefL’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, y compris son nom, sa taille en octets et un lien de téléchargement.

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 contient 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.nameNom du fichier (par exemple, profiles.parquet).
data.lengthTaille du fichier (en octets).
data._links.self.hrefL’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.nameNom du fichier (par exemple, profiles.parquet).
data._links.self.hrefL’URL de téléchargement du fichier.