Ontdek uw mappen voor cloudopslag met de API van Flow Service

Deze zelfstudie bevat stappen voor het verkennen en voorvertonen van de structuur en inhoud van uw cloudopslag met de Flow Service ​ -API.

NOTE
Als u uw cloudopslag wilt verkennen, moet u al beschikken over een geldige basis-verbindings-id voor een bron voor cloudopslag. Als u dit identiteitskaart niet hebt, dan zie het ​ overzicht van bronnen ​ voor een lijst van de bronnen van de wolkenopslag die u een basisverbinding kunt tot stand brengen met.

Aan de slag

Deze handleiding vereist een goed begrip van de volgende onderdelen van Adobe Experience Platform:

  • ​ Bronnen ​: Met Experience Platform kunt u gegevens uit verschillende bronnen invoegen en binnenkomende gegevens structureren, labelen en verbeteren met Experience Platform -services.
  • ​ Sandboxes ​: Experience Platform biedt virtuele sandboxen die één Experience Platform -instantie in afzonderlijke virtuele omgevingen verdelen om toepassingen voor digitale ervaringen te ontwikkelen en te ontwikkelen.

Experience Platform API’s gebruiken

Voor informatie over hoe te om vraag aan Experience Platform APIs met succes te maken, zie de gids op ​ begonnen wordt met Experience Platform APIs ​.

Ontdek uw mappen voor cloudopslag

U kunt informatie ophalen over de structuur van uw mappen voor cloudopslag door een aanvraag voor GET in te dienen bij de API van Flow Service en de basis-verbindings-id van uw bron op te geven.

Wanneer het uitvoeren van GET verzoeken om uw wolkenopslag te onderzoeken, moet u de vraagparameters omvatten die in de lijst hieronder worden vermeld:

Parameter
Beschrijving
objectType

Het type object dat u wilt verkennen. Stel deze waarde in op:

  • folder : Een specifieke map verkennen
  • root : Verken de hoofdmap.
object
Deze parameter is alleen vereist wanneer een specifieke map wordt weergegeven. Zijn waarde vertegenwoordigt de weg van de folder u wenst te onderzoeken.

API formaat

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object={PATH}
Parameter
Beschrijving
{BASE_CONNECTION_ID}
De basis verbindings-id van de bron voor cloudopslag.
{PATH}
Het pad van een map.

Verzoek

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

Reactie

Een succesvol antwoord retourneert een array met bestanden en mappen die in de gevraagde map zijn gevonden. Let op de eigenschap path van het bestand dat u wilt uploaden, aangezien u dit in de volgende stap moet opgeven om de structuur te controleren.

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

De structuur van een bestand controleren

Om de structuur van gegevensdossier van uw cloudopslag te inspecteren, voer een GET verzoek uit terwijl het verstrekken van de weg van het dossier en type als vraagparameter.

U kunt de structuur van een gegevensbestand van uw bron van de wolkenopslag inspecteren door een GET verzoek uit te voeren terwijl het verstrekken van de weg en het type van het dossier. U kunt ook verschillende bestandstypen inspecteren, zoals CSV, TSV of gecomprimeerde JSON en gescheiden bestanden door de bestandstypen op te geven als onderdeel van de queryparameters.

API formaat

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
Beschrijving
{BASE_CONNECTION_ID}
De verbindings-id van de bronaansluiting voor de cloud.
{FILE_PATH}
Het pad naar het bestand dat u wilt inspecteren.
{FILE_TYPE}

Het type bestand. Tot de ondersteunde bestandstypen behoren:

  • DELIMITED: Waarde gescheiden door scheidingstekens. DSV-bestanden moeten door komma’s van elkaar worden gescheiden.
  • JSON: JavaScript Object Notation. JSON-bestanden moeten XDM-compatibel zijn
  • PARQUET: Apache Parquet. Parketbestanden moeten XDM-compatibel zijn.
{QUERY_PARAMS}
Optionele queryparameters die kunnen worden gebruikt om resultaten te filteren. Zie de sectie over ​ vraagparameters ​ voor meer informatie.

Verzoek

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

Reactie

Een succesvol antwoord geeft de structuur van het gevraagde dossier met inbegrip van lijstnamen en gegevenstypes terug.

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

Query-parameters gebruiken query

Flow Service API ​ steunt het gebruik van vraagparameters aan voorproef en inspecteer verschillende dossiertypes.

Parameter
Beschrijving
columnDelimiter
De waarde van één teken die u hebt opgegeven als kolomscheidingsteken voor het inspecteren van CSV- of TSV-bestanden. Wanneer de parameter niet is opgegeven, wordt voor de waarde een komma (,) gebruikt.
compressionType

Een vereiste queryparameter voor het voorvertonen van een gecomprimeerd, gescheiden of JSON-bestand. De volgende bestanden worden ondersteund:

  • bzip2
  • gzip
  • deflate
  • zipDeflate
  • tarGzip
  • tar
encoding
Definieert welk coderingstype moet worden gebruikt bij het renderen van de voorvertoning. De ondersteunde coderingstypen zijn: UTF-8 en ISO-8859-1 . Nota: De parameter encoding is alleen beschikbaar bij het opnemen van CSV-bestanden met scheidingstekens. Andere bestandstypen worden met de standaardcodering UTF-8 opgenomen.

Volgende stappen

Aan de hand van deze zelfstudie hebt u uw cloudopslagsysteem verkend, het pad gevonden van het bestand dat u wilt introduceren in Experience Platform en de structuur ervan bekeken. U kunt deze informatie in het volgende leerprogramma gebruiken ​ gegevens van uw wolkenopslag verzamelen en het brengen in Experience Platform ​.

recommendation-more-help
experience-platform-help-sources