DokumentationExperience PlatformAnvändarhandbok om Source Connectors

Skapa en flödeskörning för on-demand-inmatning med Flow Service API

Last update: Fri Sep 29 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Developer

Flödeskörningar representerar en instans av flödeskörning. Om ett flöde till exempel är schemalagt att köras varje timme kl. 9.00, 10.00 och 11.00 har du tre instanser av en flödeskörning. Flödeskörningar är specifika för just din organisation.

Intag på begäran ger dig möjlighet att skapa ett flöde som körs mot ett givet dataflöde. Detta gör att dina användare kan skapa en flödeskörning baserat på givna parametrar och skapa en insatscykel, utan tjänstens tokens. Stöd för on-demand-konsumtion finns endast för batchkällor.

I den här självstudiekursen beskrivs hur du använder on-demand-inmatning och skapar ett flöde med Flow Service API.

Komma igång

NOTE
För att kunna skapa en flödeskörning måste du först ha flödes-ID:t för ett dataflöde som är schemalagt för engångsinmatning.

Den här självstudiekursen kräver att du har en fungerande förståelse för följande komponenter i Adobe Experience Platform:

  • Källor: Experience Platform tillåter att data hämtas från olika källor samtidigt som du kan strukturera, etikettera och förbättra inkommande data med Platform tjänster.
  • Sandlådor: Experience Platform innehåller virtuella sandlådor som partitionerar en enda Platform till separata virtuella miljöer för att utveckla och utveckla applikationer för digitala upplevelser.

Använda plattforms-API:er

Mer information om hur du kan anropa API:er för plattformar finns i handboken komma igång med plattforms-API:er.

Skapa en flödeskörning för en tabellbaserad källa

Om du vill skapa ett flöde för en tabellbaserad källa skickar du en POST till Flow Service API när du anger ID:t för det flöde som du vill köra mot samt värden för starttid, sluttid och deltakolumn.

TIP
Tabellbaserade källor omfattar följande källkategorier: annonsering, analys, samtycke och preferenser, CRM, kundframgångar, databas, automatiserad marknadsföring, betalningar och protokoll.

API-format

POST /runs/

Begäran

Följande begäran skapar en flödeskörning för flödes-ID 3abea21c-7e36-4be1-bec1-d3bad0e3e0de.

NOTE
Du behöver bara ange deltaColumn när du skapar ditt första flöde. Efter det har deltaColumn kommer att korrigeras som en del av copy förändringen i flödet och kommer att behandlas som källan till sanning. Eventuella försök att ändra deltaColumn värdet via flödeskörningsparametrarna resulterar i ett fel.
curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/runs' \
  -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}' \
  -H 'Content-Type: application/json'
  -d '{
      "flowId": "3abea21c-7e36-4be1-bec1-d3bad0e3e0de",
      "params": {
          "startTime": "1663735590",
          "windowStartTime": "1651584991",
          "windowEndTime": "16515859567",
          "deltaColumn": {
              "name": "DOB"
          }
      }
  }'
Parameter
Beskrivning
flowId
ID:t för det flöde som flödeskörningen ska skapas mot.
params.startTime
Den schemalagda tiden då flödeskörningen på begäran börjar. Detta värde representeras i unix-tid.
params.windowStartTime
Det tidigaste datum och den tidigaste tid som data hämtas från. Detta värde representeras i unix-tid.
params.windowEndTime
Datum och tid då data hämtas fram till. Detta värde representeras i unix-tid.
params.deltaColumn
Deltakolumnen krävs för att partitionera data och separera nyimporterade data från historiska data. Anteckning: deltaColumn behövs bara när du skapar ditt första flöde.
params.deltaColumn.name
Namnet på deltakolumnen.

Svar

Ett lyckat svar returnerar information om den nyligen skapade flödeskörningen, inklusive dess unika körning id.

{
    "items": [
        {
            "id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
            "etag": "\"1100c53e-0000-0200-0000-627138980000\""
        }
    ]
}
Egenskap
Beskrivning
id
ID för den nyligen skapade flödeskörningen. Se guiden på hämta flödesspecifikationer för mer information om tabellbaserade körningsspecifikationer.
etag
Resursversionen av flödeskörningen.

Skapa en flödeskörning för en filbaserad källa

Om du vill skapa ett flöde för en filbaserad källa skickar du en POST till Flow Service API när du anger ID:t för det flöde du vill skapa körningen mot och värden för start- och sluttid.

TIP
Filbaserade källor innehåller alla molnlagringskällor.

API-format

POST /runs/

Begäran

Följande begäran skapar en flödeskörning för flödes-ID 3abea21c-7e36-4be1-bec1-d3bad0e3e0de.

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/runs' \
  -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}' \
  -H 'Content-Type: application/json'
  -d '{
      "flowId": "3abea21c-7e36-4be1-bec1-d3bad0e3e0de",
      "params": {
          "startTime": "1663735590",
          "windowStartTime": "1651584991",
          "windowEndTime": "16515859567"
      }
  }'
Parameter
Beskrivning
flowId
ID:t för det flöde som flödeskörningen ska skapas mot.
params.startTime
Den schemalagda tiden då flödeskörningen på begäran börjar. Detta värde representeras i unix-tid.
params.windowStartTime
Det tidigaste datum och den tidigaste tid som data hämtas från. Detta värde representeras i unix-tid.
params.windowEndTime
Datum och tid då data hämtas fram till. Detta värde representeras i unix-tid.

Svar

Ett lyckat svar returnerar information om den nyligen skapade flödeskörningen, inklusive dess unika körning id.

{
    "items": [
        {
            "id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
            "etag": "\"1100c53e-0000-0200-0000-627138980000\""
        }
    ]
}
Egenskap
Beskrivning
id
ID för den nyligen skapade flödeskörningen. Se guiden på hämta flödesspecifikationer för mer information om tabellbaserade körningsspecifikationer.
etag
Resursversionen av flödeskörningen.

Övervaka flödeskörningar

När flödeskörningen har skapats kan du övervaka de data som importeras genom den för att se information om flödeskörningar, slutförandestatus och fel. Om du vill övervaka ditt flöde med API kan du se självstudiekursen om övervaka dataflöden i API:t. Om du vill övervaka ditt flöde med hjälp av plattformsgränssnittet läser du i handboken på övervaka källfilsflöden med kontrollpanelen.

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