Esplora le cartelle di archiviazione cloud utilizzando l'API Flow Service
Creato per:
- Sviluppatore
Questo tutorial illustra come esplorare e visualizzare in anteprima la struttura e il contenuto dell'archiviazione cloud utilizzando l'API Flow Service.
Introduzione
Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
- Origini: Experience Platform consente l'acquisizione di dati da varie origini e consente di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi Experience Platform.
- Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza di Experience Platform in ambienti virtuali separati, utili per le attività di sviluppo e aggiornamento delle applicazioni di esperienza digitale.
Utilizzo delle API di Experience Platform
Per informazioni su come effettuare correttamente chiamate alle API di Experience Platform, consulta la guida introduttiva alle API di Experience Platform.
Esplora le cartelle di archiviazione cloud
È possibile recuperare informazioni sulla struttura delle cartelle di archiviazione cloud effettuando una richiesta GET all'API Flow Service e fornendo l'ID di connessione di base dell'origine.
Quando esegui le richieste di GET per esplorare l’archiviazione cloud, devi includere i parametri di query elencati nella tabella seguente:
Parametro | Descrizione |
---|---|
objectType |
Tipo di oggetto che si desidera esplorare. Imposta questo valore come:
|
object | Questo parametro è necessario solo quando si visualizza una directory specifica. Il relativo valore rappresenta il percorso della directory che desideri esplorare. |
Formato API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object={PATH}
Parametro | Descrizione |
---|---|
{BASE_CONNECTION_ID} | ID della connessione di base dell’origine di archiviazione cloud. |
{PATH} | Percorso di una directory. |
Richiesta
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/dc3c0646-5e30-47be-a1ce-d162cb8f1f07/explore?objectType=folder&object=root' \
-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
In caso di esito positivo, la risposta restituisce un array di file e cartelle presenti nella directory in cui è stata eseguita la query. Prendere nota della proprietà path
del file che si desidera caricare, in quanto è necessario fornirlo nel passaggio successivo per esaminarne la struttura.
[
{
"type": "file",
"name": "account.csv",
"path": "/test-connectors/testFolder-fileIngestion/account.csv",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "file",
"name": "profileData.json",
"path": "/test-connectors/testFolder-fileIngestion/profileData.json",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "file",
"name": "sampleprofile--3.parquet",
"path": "/test-connectors/testFolder-fileIngestion/sampleprofile--3.parquet",
"canPreview": true,
"canFetchSchema": true
}
]
Controllare la struttura di un file
Per controllare la struttura del file di dati dall’archiviazione cloud, esegui una richiesta GET fornendo il percorso del file e digita come parametro di query.
Puoi controllare la struttura di un file di dati dall’origine dell’archiviazione cloud eseguendo una richiesta GET e fornendo il percorso e il tipo del file. Puoi anche esaminare diversi tipi di file, come CSV, TSV o JSON compresso e file delimitati specificandone i tipi come parte dei parametri di query.
Formato API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}&{QUERY_PARAMS}&preview=true
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&preview=true&fileType=delimited&columnDelimiter=\t
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&preview=true&fileType=delimited&compressionType=gzip;
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=FILE&object={FILE_PATH}&preview=true&fileType=delimited&encoding=ISO-8859-1;
{BASE_CONNECTION_ID}
{FILE_PATH}
{FILE_TYPE}
Il tipo di file. I tipi di file supportati includono:
DELIMITATO
: valore separato da delimitatore. I file DSV devono essere separati da virgole.JSON
: Notazione oggetto JavaScript. I file JSON devono essere conformi a XDMPARQUET
: Apache Parquet I file Parquet devono essere conformi a XDM.
{QUERY_PARAMS}
Richiesta
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=file&object=/aep-bootcamp/Adobe%20Pets%20Customer%2020190801%20EXP.json&fileType=json&preview=true' \
-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
In caso di esito positivo, la risposta restituisce la struttura del file oggetto della query, inclusi i nomi delle tabelle e i tipi di dati.
[
{
"name": "Id",
"type": "String"
},
{
"name": "FirstName",
"type": "String"
},
{
"name": "LastName",
"type": "String"
},
{
"name": "Email",
"type": "String"
},
{
"name": "Phone",
"type": "String"
}
]
Utilizzo dei parametri di query
Flow Service API supporta l'utilizzo di parametri di query per l'anteprima e l'analisi di diversi tipi di file.
columnDelimiter
(,)
.compressionType
Parametro query obbligatorio per l’anteprima di un file delimitato o JSON compresso. I file compressi supportati sono:
bzip2
gzip
deflate
zipDeflate
tarGzip
tar
encoding
UTF-8
e ISO-8859-1
. Nota: il parametro encoding
è disponibile solo per l'acquisizione di file CSV delimitati. Altri tipi di file verranno acquisiti con la codifica predefinita, UTF-8
.Passaggi successivi
Seguendo questa esercitazione, hai esplorato il sistema di archiviazione cloud, trovato il percorso del file che desideri importare in Experience Platform e ne hai visualizzato la struttura. Puoi utilizzare queste informazioni nel prossimo tutorial per raccogliere dati dall'archivio cloud e inserirli in Experience Platform.