Handbuch zur Data Access API

Die Data Access API unterstützt Adobe Experience Platform, indem sie Benutzern eine RESTful-Schnittstelle bereitstellt, die sich auf die Auffindbarkeit und Zugänglichkeit erfasster Datensätze in Experience Platform.

Ein Diagramm, wie Data Access die Auffindbarkeit und Zugänglichkeit erfasster Datensätze innerhalb von Experience Platform erleichtert.

API-Spezifikationsreferenz

Die Referenzdokumentation zur Swagger-API finden Sie here.

Terminologie terminology

Die Tabelle enthält eine Beschreibung einiger Begriffe, die in diesem Dokument häufig verwendet werden.

Begriff
Beschreibung
Datensatz
Eine Sammlung von Daten, die ein Schema und Felder enthält.
Batch
Eine Gruppe von Daten, die über einen bestimmten Zeitraum gesammelt und als Einheit verarbeitet wurden.

Liste der Dateien in einem Batch abrufen retrieve-list-of-files-in-a-batch

Um eine Liste von Dateien abzurufen, die zu einem bestimmten Batch gehören, verwenden Sie die Batch-Kennung (batchID) mit der Data Access API.

API-Format

GET /batches/{BATCH_ID}/files
Eigenschaft
Beschreibung
{BATCH_ID}
Die Kennung des angegebenen Batches.

Anfrage

curl -X GET https://platform.adobe.io/data/foundation/export/batches/{BATCH_ID}/files \
  -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

{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    },
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}

Die "data" -Array enthält eine Liste aller Dateien im angegebenen Batch. Jede zurückgegebene Datei verfügt über eine eigene eindeutige ID ({FILE_ID}), die in der "dataSetFileId" -Feld. Sie können diese eindeutige ID verwenden, um auf die Datei zuzugreifen oder sie herunterzuladen.

Eigenschaft
Beschreibung
data.dataSetFileId
Die Datei-ID für jede Datei im angegebenen Batch.
data._links.self.href
Die URL für den Zugriff auf die Datei.

Zugreifen auf und Herunterladen von Dateien in einem Batch

Verwenden Sie eine Datei-ID ({FILE_ID}) mit der Data Access API, einschließlich des Namens, der Größe in Byte und eines Links zum Herunterladen.

Die Antwort enthält ein Daten-Array. Je nachdem, ob es sich bei der von der ID referenzierten Datei um eine einzelne Datei oder ein Verzeichnis handelt, kann das zurückgegebene Datenarray einen einzelnen Eintrag oder eine Liste von Dateien enthalten, die zu diesem Verzeichnis gehören. Jedes Dateielement enthält die Details der Datei.

API-Format

GET /files/{FILE_ID}
Eigenschaft
Beschreibung
{FILE_ID}
Gleich "dataSetFileId", die Kennung der Datei, auf die zugegriffen werden soll.

Anfrage

curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID} \
  -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}'

Einzelne Dateiantwort

{
  "data": [
    {
      "name": "{FILE_NAME}",
      "length": "{LENGTH}",
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}
Eigenschaft
Beschreibung
data.name
Der Name der Datei (z. B. profiles.csv).
data.length
Die Größe der Datei (in Byte).
data._links.self.href
Die URL zum Herunterladen der Datei.

Verzeichnisantwort

{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 2
  }
}

Wenn ein Verzeichnis zurückgegeben wird, enthält es ein Array aller Dateien im Ordner.

Eigenschaft
Beschreibung
data.name
Der Name der Datei (z. B. profiles.csv).
data._links.self.href
Die URL zum Herunterladen der Datei.

Dateiinhalt aufrufen access-file-contents

Sie können auch die Data Access API für den Zugriff auf den Inhalt einer Datei. Sie können die Inhalte dann in eine externe Quelle herunterladen.

API-Format

GET /files/{dataSetFileId}?path={FILE_NAME}
Eigenschaft
Beschreibung
{FILE_NAME}
Der Name der Datei, auf die Sie zugreifen möchten.

Anfrage

curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME} \
  -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}'
Eigenschaft
Beschreibung
{FILE_ID}
Die ID der Datei in einem Datensatz.
{FILE_NAME}
Der vollständige Name der Datei (z. B. profiles.csv).

Antwort

Contents of the file

Zusätzliche Codebeispiele

Weitere Beispiele finden Sie im Abschnitt Tutorial zum Datenzugriff.

Abonnieren von Datenerfassungsereignissen subscribe-to-data-ingestion-events

Sie können bestimmte Ereignisse mit hohem Wert über die Adobe Developer-Konsole. Sie können beispielsweise Ereignisse zur Datenaufnahme abonnieren, um über potenzielle Verzögerungen und Fehler informiert zu werden. Weitere Informationen finden Sie im Tutorial zum Abonnieren von Datenaufnahmebenachrichtigungen.

recommendation-more-help
d71356da-cd87-452c-8a00-68926401758f