Show Menu
SUJETS×

Présentation de l’accès aux données

L’API d’accès aux données prend en charge Adobe Experience Platform en fournissant aux utilisateurs une interface RESTful axée sur la détectabilité et l’accessibilité des jeux de données imbriqués dans Experience Platform.

Référence de spécification d'API

La documentation de référence de l’API Swagger se trouve ici .

Terminologie

Description de certains termes couramment utilisés dans ce document.
Terme
Description
Jeu de données
Collection de données comprenant des schémas et des champs.
Lot
Ensemble de données collectées sur une période donnée et traitées ensemble en une seule unité.

Récupération de la liste des fichiers dans un lot

En utilisant un identifiant de lot (batchID), l'API d'accès aux données peut récupérer une liste de fichiers appartenant à ce lot particulier.
Format d’API
GET /batches/{BATCH_ID}/files

Propriété
Description
{BATCH_ID}
ID 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: {IMS_ORG}' \
  -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 "data" tableau contient une liste de tous les fichiers du lot spécifié. Chaque fichier renvoyé comporte son propre identifiant ( {FILE_ID} ) unique contenu dans le "dataSetFileId" champ. Cet identifiant unique peut ensuite être utilisé pour accéder au fichier ou le télécharger.
Propriété
Description
data.dataSetFileId
ID de fichier pour chaque fichier du lot spécifié.
data._links.self.href
URL d’accès au fichier.

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

En utilisant un identifiant de fichier ( {FILE_ID} ), l'API d'accès aux données permet d'accéder aux détails spécifiques d'un fichier, 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 pointé par l'ID est un fichier individuel ou un répertoire, le tableau de données renvoyé peut contenir une entrée unique 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 à 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: {IMS_ORG}' \
  -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, profils.csv).
data.length
Taille du fichier (en octets).
data._links.self.href
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 qu’il contient.
Propriété
Description
data.name
Nom du fichier (par exemple, profils.csv).
data._links.self.href
URL de téléchargement du fichier.

Accès au contenu d’un fichier

L'API d'accès aux données permet également d'accéder au contenu d'un fichier. Vous pouvez ensuite l’utiliser pour télécharger le contenu vers une source externe.
Format d’API
GET /files/{dataSetFileId}?path={FILE_NAME}

Propriété
Description
{FILE_NAME}
Nom du fichier auquel vous tentez 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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Propriété
Description
{FILE_ID}
ID du fichier dans un jeu de données.
{FILE_NAME}
Nom complet du fichier (par exemple, profils.csv).
Réponse
Contents of the file

Exemples de code supplémentaires

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

S'abonner aux événements d'assimilation de données

La plate-forme met à disposition des événements spécifiques à forte valeur ajoutée pour l’abonnement via la console de développement Adobe. Par exemple, vous pouvez vous abonner à des événements d'assimilation de données pour être averti des retards et des échecs potentiels. Pour plus d'informations, consultez le didacticiel sur l' abonnement aux notifications d'assimilation de données.