Show Menu
SUJETS×

Guide du développeur d'accès aux données

The Data Access API supports Adobe Experience Platform by providing users with a RESTful interface focused on the discoverability and accessibility of ingested datasets within Experience Platform.

Référence de spécification API

Vous trouverez ici la documentation de référence de l’API Swagger.

Terminologie

Une description de certains des termes utilisés couramment tout au long de ce document.
Terme
Description
Jeu de données
Un ensemble de données qui inclut des schémas 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

En utilisant un identifiant de lot (batchID), l’API Data Access peut récupérer une liste des fichiers appartenant à un lot spécifique.
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: {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 tableau "data" contient une liste de tous les fichiers au sein d’un lot spécifique. Chaque fichier renvoyé possède son propre identifiant unique ( {FILE_ID} ) contenu dans le champ "dataSetFileId" . Vous pouvez ensuite 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

En utilisant un identifiant de fichier ( {FILE_ID} ), l’API Data Access permet d’accéder aux détails spécifiques d’un fichier, notamment son nom, sa taille et un lien de téléchargement.
La réponse contiendra 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 du fichier inclura 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: {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 ex. : 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 ex. : profiles.csv).
data._links.self.href
L’URL de téléchargement du fichier.

Accès aux contenus d’un fichier

The Data Access API can also be used to access the contents of a file. Vous pouvez ensuite l’utiliser pour télécharger les contenus 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: {IMS_ORG}' \
  -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}
Le nom complet du fichier (par ex. : profiles.csv).
Réponse
Contents of the file

Exemples de code supplémentaires

Pour consulter d’autres exemples, veuillez vous reporter au tutoriel d’accès aux données .

Abonnement aux événements d’ingestion de données

Platform rend des événements spécifiques à forte valeur ajoutée disponibles pour l’abonnement via la console de développement Adobe. 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 didacticiel sur l' abonnement aux notifications d'assimilation de données.