Utforska dina molnlagringsmappar med Flow Service API

I den här självstudiekursen beskrivs hur du utforskar och förhandsgranskar strukturen och innehållet i ditt molnlagringsutrymme med hjälp av Flow Service API.

NOTE
För att kunna utforska ditt molnlagringsutrymme måste du redan ha ett giltigt ID för basanslutning för en molnlagringskälla. Om du inte har detta ID kan du se källöversikt för en lista över molnlagringskällor som du kan skapa en basanslutning med.

Komma igång

Handboken kräver en fungerande förståelse av följande komponenter i Adobe Experience Platform:

  • Källor: Experience Platform tillåter att data hämtas från olika källor samtidigt som du kan strukturera, etikettera och förbättra inkommande data med Platform tjänster.
  • Sandlådor: Experience Platform innehåller virtuella sandlådor som partitionerar en enda Platform till separata virtuella miljöer för att utveckla och utveckla applikationer för digitala upplevelser.

Använda plattforms-API:er

Mer information om hur du kan anropa API:er för plattformar finns i handboken komma igång med plattforms-API:er.

Utforska dina molnlagringsmappar

Du kan hämta information om strukturen för dina molnlagringsmappar genom att göra en GET-förfrågan till Flow Service API när du anger källans anslutnings-ID.

När du gör GET-förfrågningar för att utforska ditt molnlagringsutrymme måste du inkludera frågeparametrarna som listas i tabellen nedan:

Parameter
Beskrivning
objectType

Den typ av objekt som du vill utforska. Ange det här värdet som antingen:

  • folder: Utforska en specifik katalog
  • root: Utforska rotkatalogen.
object
Den här parametern krävs bara när du visar en viss katalog. Dess värde representerar sökvägen till den katalog du vill utforska.

API-format

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object={PATH}
Parameter
Beskrivning
{BASE_CONNECTION_ID}
Basanslutnings-ID för molnlagringskällan.
{PATH}
Sökvägen till en katalog.

Begäran

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

Svar

Ett lyckat svar returnerar en array med filer och mappar som finns i den efterfrågade katalogen. Observera path -egenskapen för filen som du vill överföra, eftersom du måste ange den i nästa steg för att kunna kontrollera dess struktur.

[
    {
        "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 en fils struktur

Om du vill inspektera datafilens struktur från ditt molnlagringsutrymme utför du en GET-förfrågan och anger filens sökväg och typ som en frågeparameter.

Du kan inspektera datafilens struktur från molnlagringskällan genom att utföra en GET-begäran och samtidigt ange filens sökväg och typ. Du kan också inspektera olika filtyper, till exempel CSV, TSV eller komprimerad JSON och avgränsade filer, genom att ange deras filtyper som en del av frågeparametrarna.

API-format

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;
Parameter
Beskrivning
{BASE_CONNECTION_ID}
Anslutnings-ID för din molnlagringskälla.
{FILE_PATH}
Sökvägen till filen som du vill inspektera.
{FILE_TYPE}

Filtypen. Filtyper som stöds:

  • DELIMITED: Avgränsaravgränsat värde. DSV-filer måste vara kommaavgränsade.
  • JSON: JavaScript-objektnotation. JSON-filer måste vara XDM-kompatibla
  • PARQUET: Apache Parquet. Parquet-filer måste vara XDM-kompatibla.
{QUERY_PARAMS}
Valfria frågeparametrar som kan användas för att filtrera resultat. Se avsnittet om frågeparametrar för mer information.

Begäran

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

Svar

Ett lyckat svar returnerar strukturen för den efterfrågade filen inklusive tabellnamn och datatyper.

[
    {
        "name": "Id",
        "type": "String"
    },
    {
        "name": "FirstName",
        "type": "String"
    },
    {
        "name": "LastName",
        "type": "String"
    },
    {
        "name": "Email",
        "type": "String"
    },
    {
        "name": "Phone",
        "type": "String"
    }
]

Använda frågeparametrar query

The Flow Service API har stöd för användning av frågeparametrar för att förhandsgranska och inspektera olika filtyper.

Parameter
Beskrivning
columnDelimiter
Värdet för ett tecken som du angav som en kolumnavgränsare för att inspektera CSV- eller TSV-filer. Om parametern inte anges används standardvärdet kommatecken (,).
compressionType

En obligatorisk frågeparameter för förhandsgranskning av en komprimerad avgränsad fil eller JSON-fil. Komprimerade filer som stöds är:

  • bzip2
  • gzip
  • deflate
  • zipDeflate
  • tarGzip
  • tar
encoding
Definierar vilken kodningstyp som ska användas vid förhandsgranskning av återgivning. Följande kodningstyper stöds: UTF-8 och ISO-8859-1. Anteckning: encoding -parametern är bara tillgänglig vid inhämtning av avgränsade CSV-filer. Andra filtyper kommer att importeras med standardkodningen, UTF-8.

Nästa steg

Genom att följa den här självstudiekursen har du utforskat ditt molnlagringssystem och hittat sökvägen till filen som du vill hämta till Platformoch visade sin struktur. Du kan använda den här informationen i nästa självstudie för att samla in data från din molnlagring och ta in dem på plattformen.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089