Guide de l’API Data Access

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.

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 terminology

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

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 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

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.

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}

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
  }
}

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.

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}

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}'

Réponse

Contents of the file

Exemples de code supplémentaires

Pour obtenir des exemples supplémentaires, 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 spécifiques à forte valeur ajoutée via 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’événement d’Adobe.