Handbuch zur Datenzugriffs-API

Die Datenzugriffs-API unterstützt Adobe Experience Platform, indem sie Benutzenden eine RESTful-Schnittstelle bereitstellt, die sich auf die Auffindbarkeit und Zugänglichkeit aufgenommener Datensätze innerhalb von Experience Platform konzentriert.

API-Spezifikationsreferenz

In der OpenAPI-Referenzdokumentation für den Datenzugriff finden Sie ein standardisiertes, maschinenlesbares Format für eine einfachere Integration, Tests und Untersuchung.

Terminologie terminology

Die Tabelle enthält eine Beschreibung einiger in diesem Dokument häufig verwendeter Begriffe.

Abrufen einer Liste von Dateien in einem Batch 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 Datenzugriffs-API.

API-Format

GET /batches/{BATCH_ID}/files

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

Das "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 im "dataSetFileId" enthalten ist. Mit dieser eindeutigen ID können Sie auf die Datei zugreifen oder sie herunterladen.

Zugreifen auf und Herunterladen von Dateien in einem Batch

Um auf bestimmte Details einer Datei zuzugreifen, verwenden Sie eine Dateikennung ({FILE_ID}) mit der Datenzugriffs-API, einschließlich ihres Namens, ihrer Größe in Byte und eines Links zum Herunterladen.

Die Antwort enthält ein Daten-Array. Je nachdem, ob es sich bei der Datei, auf die die ID verweist, um eine einzelne Datei oder ein Verzeichnis handelt, kann das zurückgegebene Daten-Array 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}

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

Einzeldatei-Antwort

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

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 Verzeichnis .

Zugriff auf den Inhalt einer Datei access-file-contents

Sie können auch die Data Access-API verwenden, um auf den Inhalt einer Datei zuzugreifen. Anschließend können Sie die Inhalte in eine externe Quelle herunterladen.

API-Format

GET /files/{dataSetFileId}?path={FILE_NAME}

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

Antwort

Contents of the file

Zusätzliche Code-Beispiele

Weitere Beispiele finden Sie im Tutorial zum Datenzugriff.

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

Sie können bestimmte hochwertige Ereignisse über die Adobe Developer Console}. Sie können beispielsweise Ereignisse zur Datenaufnahme abonnieren, um über potenzielle Verzögerungen und Fehler informiert zu werden. Weitere Informationen finden Sie im Tutorial Abonnieren von AdobeEreignisbenachrichtigungen“.