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.

Uw gegevenstabellen verkennen

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

API formaat

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
ParameterBeschrijving
{BASE_CONNECTION_ID}De basis verbindings-id van uw bron.

Verzoek

curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/5e73e5a2-dc36-45a8-9f16-93c7a43af318/explore?objectType=root' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Reactie

Een geslaagde reactie retourneert een array met tabellen uit uw bron. Zoek de tabel die u naar Experience Platform wilt brengen en neem nota van de eigenschap path ervan, aangezien u deze in de volgende stap moet verstrekken om de structuur te inspecteren.

[
    {
        "type": "table",
        "name": "ACME Spring Campaign",
        "path": "acmeSpringCampaign",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "ACME Summer Campaign",
        "path": "acmeSummerCampaign",
        "canPreview": true,
        "canFetchSchema": true
    }
]

De structuur van een tabel controleren

Om de inhoud van uw gegevenslijsten te inspecteren, voer een verzoek van GET aan Flow Service API uit terwijl het specificeren van de weg van een lijst als vraagparameter.

API formaat

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
ParameterBeschrijving
{BASE_CONNECTION_ID}De basis verbindings-id van uw bron.
{TABLE_PATH}De eigenschap path van de tabel die u wilt inspecteren.

Verzoek

curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/5e73e5a2-dc36-45a8-9f16-93c7a43af318/explore?objectType=table&object=acmeSpringCampaign' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Reactie

Een geslaagde reactie retourneert informatie over de inhoud en structuur van de opgegeven tabel. De details betreffende elk van de kolommen van de lijst worden gevestigd binnen elementen van de columns serie.

{
  "format": "flat",
  "schema": {
    "columns": [
      {
        "name": "TestID",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "Name",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "Datefield",
        "type": "string",
        "meta:xdmType": "date-time",
        "xdm": {
          "type": "string",
          "format": "date-time"
        }
      },
      {
        "name": "complaint_type",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "complaint_description",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "status",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "status_change_date",
        "type": "string",
        "meta:xdmType": "date-time",
        "xdm": {
          "type": "string",
          "format": "date-time"
        }
      },
      {
        "name": "city",
        "type": "string",
        "xdm": {
          "type": "string"
        }
      },
      {
        "name": "Datefield2",
        "type": "string",
        "meta:xdmType": "date-time",
        "xdm": {
          "type": "string",
          "format": "date-time"
        }
      }
    ]
  }
}