Guida dell’API di accesso ai dati
L'API di accesso ai dati supporta Adobe Experience Platform fornendo agli utenti un'interfaccia RESTful incentrata sulla reperibilità e l'accessibilità dei set di dati acquisiti in Experience Platform.
Riferimento alle specifiche API
La documentazione di riferimento OpenAPI è disponibile qui.
Terminologia terminology
La tabella fornisce una descrizione di alcuni termini comunemente utilizzati in questo documento.
Recuperare l'elenco dei file all'interno di un batch retrieve-list-of-files-in-a-batch
Per recuperare un elenco di file appartenenti a un batch specifico, utilizzare l'identificatore batch (batchID) con l'API di accesso ai dati.
Formato API
GET /batches/{BATCH_ID}/files
{BATCH_ID}
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: {ORG_ID}' \
-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}
) contenuto nel campo "dataSetFileId"
. Puoi usare questo ID univoco per accedere o scaricare il file.
data.dataSetFileId
data._links.self.href
Accesso e download di file all'interno di un batch
Per accedere a dettagli specifici di un file, utilizzare un identificatore di file ({FILE_ID}
) con l'API di accesso ai dati, incluso il nome, la dimensione in byte e un collegamento per il download.
La risposta contiene 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 del file include i dettagli del file.
Formato API
GET /files/{FILE_ID}
{FILE_ID}
"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: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Risposta su 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
}
}
data.name
profiles.csv
.data.length
data._links.self.href
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, questa contiene una matrice di tutti i file all'interno della directory.
data.name
profiles.csv
.data._links.self.href
Accedere al contenuto di un file access-file-contents
È inoltre possibile utilizzare l'API Data Access per accedere al contenuto di un file. Puoi quindi scaricare il contenuto in un’origine esterna.
Formato API
GET /files/{dataSetFileId}?path={FILE_NAME}
{FILE_NAME}
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: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
{FILE_ID}
{FILE_NAME}
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 acquisizione dati subscribe-to-data-ingestion-events
È possibile sottoscrivere eventi specifici di valore elevato tramite Adobe Developer Console. Ad esempio, puoi abbonarti agli eventi di acquisizione dati per ricevere notifiche su potenziali ritardi e errori. Per ulteriori informazioni, consulta l'esercitazione su abbonamento a notifiche di acquisizione dati.