Erkunden von Cloud-Speicherordnern mit der Flow Service-API
Erstellt für:
- Entwickler
In diesem Tutorial erfahren Sie, wie Sie die Struktur und die Inhalte Ihres Cloud-Speichers mithilfe der Flow Service-API untersuchen und in der Vorschau anzeigen.
Erste Schritte
Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Adobe Experience Platform voraus:
- Quellen: Experience Platform ermöglicht die Aufnahme von Daten aus verschiedenen Quellen und bietet Ihnen die Möglichkeit, die eingehenden Daten mithilfe von Experience Platform-Services zu strukturieren, zu kennzeichnen und anzureichern.
- Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Experience Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse entwickeln und weiterentwickeln können.
Verwenden von Experience Platform-APIs
Informationen zum erfolgreichen Aufrufen von Experience Platform-APIs finden Sie im Handbuch unter mit Experience Platform-APIs.
Erkunden von Cloud-Speicherordnern
Sie können Informationen zur Struktur Ihrer Cloud-Speicherordner abrufen, indem Sie eine GET-Anfrage an die Flow Service-API richten und dabei die Basisverbindungs-ID Ihrer Quelle angeben.
Bei der Durchführung von GET-Anfragen zur Untersuchung Ihres Cloud-Speichers müssen Sie die in der folgenden Tabelle aufgeführten Abfrageparameter einbeziehen:
Parameter | Beschreibung |
---|---|
objectType |
Der Typ des Objekts, das Sie untersuchen möchten. Legen Sie diesen Wert wie folgt fest:
|
object | Dieser Parameter ist nur beim Anzeigen eines bestimmten Ordners erforderlich. Der Wert stellt den Pfad des Ordners dar, den Sie untersuchen möchten. |
API-Format
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object={PATH}
Parameter | Beschreibung |
---|---|
{BASE_CONNECTION_ID} | Die ID der Basisverbindung Ihrer Cloud-Speicherquelle. |
{PATH} | Der Pfad eines Verzeichnisses. |
Anfrage
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}'
Antwort
Eine erfolgreiche Antwort gibt ein Array von Dateien und Ordnern zurück, die im abgefragten Verzeichnis gefunden wurden. Notieren Sie sich die path
-Eigenschaft der Datei, die Sie hochladen möchten, da Sie sie im nächsten Schritt bereitstellen müssen, um die Struktur zu überprüfen.
[
{
"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
}
]
Überprüfen der Dateistruktur
Um die Dateistruktur aus Ihrem Cloud-Speicher zu überprüfen, führen Sie eine GET-Anfrage aus, während Sie den Dateipfad und -typ als Abfrageparameter angeben.
Sie können die Struktur einer Datendatei aus Ihrer Cloud-Speicherquelle überprüfen, indem Sie eine GET-Anfrage ausführen und dabei den Pfad und den Typ der Datei angeben. Sie können auch verschiedene Dateitypen wie CSV-, TSV- oder komprimierte JSON- und durch Trennzeichen getrennte Dateien untersuchen, indem Sie deren Dateitypen als Teil der Abfrageparameter angeben.
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;
{BASE_CONNECTION_ID}
{FILE_PATH}
{FILE_TYPE}
Der Typ der Datei. Zu den unterstützten Dateitypen gehören:
GETRENNT
: Durch Trennzeichen getrennter Wert. DSV-Dateien müssen durch Kommas getrennt sein.JSON
: JavaScript-Objektnotation. JSON-Dateien müssen XDM-kompatibel sein- ``In: Apache Parquet. Parquet-Dateien müssen XDM-kompatibel sein.
{QUERY_PARAMS}
Anfrage
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}'
Antwort
Eine erfolgreiche Antwort gibt die Struktur der abgefragten Datei zurück, einschließlich Tabellennamen und Datentypen.
[
{
"name": "Id",
"type": "String"
},
{
"name": "FirstName",
"type": "String"
},
{
"name": "LastName",
"type": "String"
},
{
"name": "Email",
"type": "String"
},
{
"name": "Phone",
"type": "String"
}
]
Verwenden von Abfrageparametern
Die Flow Service API unterstützt die Verwendung von Abfrageparametern zur Vorschau und Untersuchung verschiedener Dateitypen.
columnDelimiter
(,)
.compressionType
Ein erforderlicher Abfrageparameter für die Vorschau einer komprimierten oder durch Trennzeichen getrennten JSON-Datei. Folgende komprimierte Dateien werden unterstützt:
bzip2
gzip
deflate
zipDeflate
tarGzip
tar
encoding
UTF-8
und ISO-8859-1
. Hinweis: Der encoding
-Parameter ist nur verfügbar, wenn durch Trennzeichen getrennte CSV-Dateien aufgenommen werden. Andere Dateitypen werden mit der Standardcodierung UTF-8
aufgenommen.Nächste Schritte
In diesem Tutorial haben Sie Ihr Cloud-Speichersystem erkundet, den Pfad der Datei gefunden, die Sie in Experience Platform einbringen möchten, und ihre Struktur betrachtet. Sie können diese Informationen im nächsten Tutorial verwenden um Daten aus Ihrem Cloud-Speicher zu erfassen und in Experience Platform zu.