API-handleiding voor gegevenstoegang

Laatst bijgewerkt: 6 maart 2025

Gemaakt voor:

  • Ontwikkelaar
IMPORTANT
De Toegang API van Gegevens is nu verouderd ​. U wordt aangeraden Doelen te gebruiken voor het exporteren van gegevens uit Adobe Experience Platform. Voor meer informatie, gelieve te verwijzen naar de documentatie van de de uitvoerbestemmingen van de dataset.

De API voor gegevenstoegang ondersteunt Adobe Experience Platform door gebruikers een RESTful-interface te bieden die is gericht op de detecteerbaarheid en toegankelijkheid van opgenomen datasets binnen Experience Platform .

een diagram van hoe de Toegang van Gegevens de ontdekkingsbaarheid en de toegankelijkheid van ingebedde datasets binnen Experience Platform vergemakkelijkt.

API-specificatieverwijzing

Verwijs naar de de verwijzingsdocumentatie van OpenAPI van de Toegang van Gegevensom een gestandaardiseerd, machine-leesbaar formaat voor gemakkelijkere integratie, het testen, en de exploratie te bekijken.

Terminologie

De tabel bevat een beschrijving van enkele termen die in dit document worden gebruikt.

TermBeschrijving
GegevenssetEen verzameling gegevens die een schema en velden bevat.
BatchEen reeks gegevens die over een bepaalde periode worden verzameld en samen als één eenheid worden verwerkt.

Lijst met bestanden in een batch ophalen

Als u een lijst wilt ophalen met bestanden die tot een bepaalde batch behoren, gebruikt u de batch-id (batchID) met de API voor gegevenstoegang.

API formaat

GET /batches/{BATCH_ID}/files
EigenschapBeschrijving
{BATCH_ID}De id van de opgegeven batch.

Verzoek

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

Reactie

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

De array "data" bevat een lijst met alle bestanden in de opgegeven batch. Elk geretourneerd bestand heeft een eigen unieke id ({FILE_ID}) in het veld "dataSetFileId" . Met deze unieke id kunt u het bestand openen of downloaden.

EigenschapBeschrijving
data.dataSetFileIdDe bestands-id voor elk bestand in de opgegeven batch.
data._links.self.hrefDe URL voor toegang tot het bestand.

Bestanden in een batch openen en downloaden

Om tot specifieke details van een dossier toegang te hebben, gebruik een dossierherkenningsteken ({FILE_ID}) met de API van de Toegang van Gegevens, met inbegrip van zijn naam, grootte in bytes, en een verbinding om te downloaden.

De reactie bevat een gegevensarray. Afhankelijk van het feit of het bestand waarnaar de id verwijst een afzonderlijk bestand of een map is, kan de geretourneerde gegevensarray één item of een lijst met bestanden bevatten die tot die map behoren. Elk bestandselement bevat de details van het bestand.

API formaat

GET /files/{FILE_ID}
EigenschapBeschrijving
{FILE_ID}De id van het bestand dat moet worden geopend, komt overeen met de "dataSetFileId" .

Verzoek

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

Enige dossierreactie

{
  "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
  }
}
EigenschapBeschrijving
data.nameDe naam van het bestand (bijvoorbeeld profiles.parquet ).
data.lengthDe bestandsgrootte (in bytes).
data._links.self.hrefDe URL waarmee het bestand moet worden gedownload.

reactie van de Folder

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

Wanneer een map wordt geretourneerd, bevat deze een array van alle bestanden in de map.

EigenschapBeschrijving
data.nameDe naam van het bestand (bijvoorbeeld profiles.parquet ).
data._links.self.hrefDe URL waarmee het bestand moet worden gedownload.