Esplora le cartelle di archiviazione cloud utilizzando Flow Service API

Ultimo aggiornamento: 2023-11-04
  • Argomenti:
  • Sources
    Visualizza ulteriori informazioni su questo argomento
  • Creato per:
  • Developer
    User
    Admin
    Leader

Questo tutorial illustra come esplorare e visualizzare in anteprima la struttura e i contenuti dell’archiviazione cloud utilizzando Flow Service API.

NOTA

Per esplorare l’archiviazione cloud, è necessario disporre già di un ID connessione di base valido per un’origine di archiviazione cloud. Se non disponi di questo ID, consulta panoramica sulle origini per un elenco delle origini di archiviazione cloud con cui è possibile creare una connessione di base.

Introduzione

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:

  • Sorgenti: Experience Platform consente di acquisire dati da varie origini e allo stesso tempo di strutturare, etichettare e migliorare i dati in arrivo tramite Platform servizi.
  • Sandbox: Experience Platform fornisce sandbox virtuali che permettono di suddividere un singolo Platform in ambienti virtuali separati, per facilitare lo sviluppo e l’evoluzione delle applicazioni di esperienza digitale.

Utilizzo delle API di Platform

Per informazioni su come effettuare correttamente chiamate alle API di Platform, consulta la guida su introduzione alle API di Platform.

Esplora le cartelle di archiviazione cloud

Per recuperare informazioni sulla struttura delle cartelle di archiviazione cloud, effettua una richiesta GET al Flow Service fornendo l’ID della connessione di base della sorgente.

Quando esegui richieste 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:
  • folder: esplora una directory specifica
  • root: esplora la directory principale.
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. Prendi nota della path del file che desideri 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
    }
]

Inspect: struttura di un file

Per controllare la struttura del file di dati dall’archiviazione cloud, esegui una richiesta di 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 di 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;
Parametro Descrizione
{BASE_CONNECTION_ID} ID di connessione del connettore di origine dell’archiviazione cloud.
{FILE_PATH} Percorso del file che si desidera controllare.
{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 XDM
  • PARQUET: Apache Parquet I file Parquet devono essere conformi a XDM.
{QUERY_PARAMS} Parametri di query facoltativi che possono essere utilizzati per filtrare i risultati. Consulta la sezione su parametri di query per ulteriori informazioni.

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

Il Flow Service API supporta l’utilizzo di parametri di query per l’anteprima e l’ispezione di diversi tipi di file.

Parametro Descrizione
columnDelimiter Il valore di un singolo carattere specificato come delimitatore di colonna per esaminare i file CSV o TSV. Se il parametro non viene fornito, il valore predefinito è una virgola (,).
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 Definisce il tipo di codifica da utilizzare per il rendering dell'anteprima. I tipi di codifica supportati sono: UTF-8 e ISO-8859-1. Nota: Il encoding Il parametro è disponibile solo durante 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 e trovato il percorso del file che desideri importare in Platforme ne ha visualizzato la struttura. Queste informazioni sono disponibili nell'esercitazione successiva per raccogliere dati dall’archiviazione cloud e inserirli in Platform.

In questa pagina