Guida all’API di accesso ai dati

L’API di accesso ai dati supporta Adobe Experience Platform fornendo agli utenti un’interfaccia RESTful incentrata sulla scoperta e l’accessibilità dei set di dati acquisiti all’interno di Experience Platform.

Accesso ai dati su Experience Platform

Riferimento alle specifiche API

La documentazione di riferimento dell’API Swagger si trova qui.

Terminologia

Una descrizione di alcuni termini comunemente utilizzati in questo documento.

Termine Descrizione
Set di dati Raccolta di dati che include schema e campi.
Batch Un insieme di dati raccolti in un periodo di tempo ed elaborati insieme come un’unica unità.

Recupera elenco di file all’interno di un batch

Utilizzando un identificatore batch (batchID), l'API di accesso ai dati può recuperare un elenco di file appartenenti a quel particolare batch.

Formato API

GET /batches/{BATCH_ID}/files
Proprietà Descrizione
{BATCH_ID} ID del batch specificato.

Richiesta

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

Risposta

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

L’array "data" contiene un elenco di tutti i file all’interno del batch specificato. Ogni file restituito ha il proprio ID univoco ({FILE_ID}) all’interno del campo "dataSetFileId" . Questo ID univoco può quindi essere utilizzato per accedere o scaricare il file.

Proprietà Descrizione
data.dataSetFileId ID file per ogni file nel batch specificato.
data._links.self.href URL per accedere al file.

Accedere e scaricare file in un batch

Utilizzando un identificatore di file ({FILE_ID}), l'API di accesso ai dati può essere utilizzata per accedere a dettagli specifici di un file, tra cui il nome, le dimensioni in byte e un collegamento da scaricare.

La risposta conterrà un array di dati. A seconda che il file a cui fa riferimento l’ID sia un singolo file o una directory, l’array di dati restituito può contenere una singola voce o un elenco di file appartenenti a tale directory. Ogni elemento file includerà i dettagli del file.

Formato API

GET /files/{FILE_ID}
Proprietà Descrizione
{FILE_ID} Uguale al "dataSetFileId", l’ID del file a cui accedere.

Richiesta

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

Risposta a file singolo

{
  "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
  }
}
Proprietà Descrizione
data.name Nome del file (ad esempio profiles.csv).
data.length Dimensioni del file (in byte).
data._links.self.href URL per scaricare il file.

Risposta directory

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

Quando viene restituita una directory, contiene una matrice di tutti i file all’interno della directory.

Proprietà Descrizione
data.name Nome del file (ad esempio profiles.csv).
data._links.self.href URL per scaricare il file.

Accedere al contenuto di un file

L’ API Data Access può essere utilizzata anche per accedere ai contenuti di un file. Può quindi essere utilizzato per scaricare i contenuti in un’origine esterna.

Formato API

GET /files/{dataSetFileId}?path={FILE_NAME}
Proprietà Descrizione
{FILE_NAME} Nome del file a cui si sta tentando di accedere.

Richiesta

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}'
Proprietà Descrizione
{FILE_ID} ID del file all’interno di un set di dati.
{FILE_NAME} Nome completo del file (ad esempio profiles.csv).

Risposta

Contents of the file

Esempi di codice aggiuntivi

Per ulteriori esempi, consulta l’ esercitazione sull’accesso ai dati.

Iscriviti agli eventi di inserimento dati

Platform rende disponibili per l’abbonamento eventi specifici di alto valore tramite Adobe Developer Console. Ad esempio, puoi abbonarti a eventi di inserimento dati per ricevere notifiche su potenziali ritardi e errori. Per ulteriori informazioni, consulta l’esercitazione su iscrizione alle notifiche di inserimento dati .

In questa pagina