Gegevenstabellen verkennen met de opdracht Flow Service API

Deze zelfstudie bevat stappen voor het verkennen en voorvertonen van de structuur en inhoud van uw gegevenstabellen met behulp van de Flow Service API.

NOTE
Als u uw gegevenstabellen wilt verkennen, moet u al over een geldige basis-verbindings-id voor een tabelbron beschikken. Als u deze id niet hebt, raadpleegt u de volgende zelfstudies voor stappen voor het maken van een basis-verbindings-id voor een tabelbron:

Aan de slag

Deze handleiding vereist een goed begrip van de volgende onderdelen van Adobe Experience Platform:

  • Bronnen: Experience Platform staat gegevens toe om uit diverse bronnen worden opgenomen terwijl het voorzien van de capaciteit om, inkomende gegevens te structureren te etiketteren en te verbeteren gebruikend Platform diensten.
  • Sandboxen: Experience Platform biedt virtuele sandboxen die één enkele partitie maken Platform in afzonderlijke virtuele omgevingen om toepassingen voor digitale ervaringen te ontwikkelen en te ontwikkelen.

Platform-API's gebruiken

Zie de handleiding voor informatie over hoe u aanroepen naar Platform-API's kunt uitvoeren aan de slag met Platform-API's.

Uw gegevenstabellen verkennen

U kunt informatie over de structuur van uw gegevenslijsten terugwinnen door een verzoek van de GET aan Flow Service API terwijl het verstrekken van de identiteitskaart van de basisverbinding van uw bron.

API-indeling

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
Parameter
Beschrijving
{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}'

Antwoord

Een geslaagde reactie retourneert een array met tabellen uit uw bron. Zoek de tabel die u in het Platform wilt opnemen en neem nota van de tabel path eigenschap, aangezien u het in de volgende stap moet verstrekken om zijn 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 Inspect

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

API-indeling

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
Parameter
Beschrijving
{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}'

Antwoord

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 columns array.

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

Volgende stappen

Door dit leerprogramma te volgen, hebt u informatie over de structuur en de inhoud van uw gegevenslijsten verzameld. Bovendien hebt u de weg aan de lijst teruggewonnen die u in Platform wilt opnemen. U kunt deze informatie gebruiken om een bronverbinding en een gegevensstroom tot stand te brengen om uw gegevens aan Platform te brengen. Zie de volgende zelfstudies voor specifieke stappen voor het maken van een bronverbinding en een gegevensstroom met de Flow Service API:

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089