Een stroom maken die wordt uitgevoerd voor opname op aanvraag met de API Flow Service

De looppas van de stroom vertegenwoordigt een geval van stroomuitvoering. Bijvoorbeeld, als een stroom wordt gepland om te lopen bij 9 :00 AM, 10 :00 AM, en 11 :00 AM, dan zou u drie instanties van een stroomlooppas hebben. De looppas van de stroom is specifiek voor uw bepaalde organisatie.

Op bestelling kunt u een stroom maken die tegen een gegeven gegevensstroom wordt uitgevoerd. Dit staat uw gebruikers toe om een stroomlooppas tot stand te brengen, die op bepaalde parameters wordt gebaseerd en een opnamecyclus, zonder de diensttekenen tot stand te brengen. Ondersteuning voor inname op aanvraag is alleen beschikbaar voor batchbronnen.

Dit leerprogramma behandelt de stappen op hoe te om op bestelling ingestie te gebruiken en een stroom tot stand te brengen die Flow Service API ​ gebruikt.

TIP
Als u een flowuitvoering opnieuw uitvoert, worden alleen bestanden met tijdstempels verwerkt die binnen het bereik van de oorspronkelijke uitvoering vallen.

Aan de slag

NOTE
Als u een flowuitvoering wilt maken, moet u eerst over de flow-id van een gegevensstroom beschikken die voor eenmalige invoer is gepland.

Voor deze zelfstudie hebt u een goed inzicht nodig in de volgende onderdelen van Adobe Experience Platform:

  • ​ Bronnen ​: Experience Platform staat gegevens toe om van diverse bronnen worden opgenomen terwijl het voorzien van u van de capaciteit om, inkomende gegevens te structureren te etiketteren en te verbeteren gebruikend Experience Platform diensten.
  • ​ Sandboxen ​: Experience Platform verstrekt virtuele zandbakken die één enkele Experience Platform instantie in afzonderlijke virtuele milieu's verdelen helpen digitale ervaringstoepassingen ontwikkelen en ontwikkelen.

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

Een doorloop maken die wordt uitgevoerd voor een op tabellen gebaseerde bron

Als u een stroom voor een op een tabel gebaseerde bron wilt maken, dient u een POST-aanvraag in bij de Flow Service API en geeft u de id op van de flow waarop u de run wilt maken, evenals waarden voor begintijd, eindtijd en delta-kolom.

TIP
De op lijst-gebaseerde bronnen omvatten de volgende broncategorieën: reclame, analyses, toestemming en voorkeur, CRMs, klantensucces, gegevensbestand, marketing automatisering, betalingen, en protocollen.

API formaat

POST /runs/

Verzoek

Met de volgende aanvraag wordt een flowuitvoering voor de flow-id 3abea21c-7e36-4be1-bec1-d3bad0e3e0de gemaakt.

NOTE
U hoeft de deltaColumn alleen op te geven wanneer u de eerste flowuitvoering maakt. Hierna wordt deltaColumn als onderdeel van copy -transformatie in de flow gerepareerd en wordt het als de bron van de waarheid beschouwd. Als u probeert de waarde deltaColumn te wijzigen via de parameters van de flowuitvoering, treedt er een fout op.
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
Beschrijving
flowId
De id van de flow waarop de flow wordt uitgevoerd.
params.startTime
De geplande tijd van wanneer de de stroomlooppas op bestelling zal beginnen. Deze waarde wordt uitgedrukt in unieke tijd.
params.windowStartTime
De vroegste datum en tijd waarop de gegevens worden opgehaald. Deze waarde wordt uitgedrukt in unieke tijd.
params.windowEndTime
De datum en tijd waarop de gegevens worden opgehaald tot. Deze waarde wordt uitgedrukt in unieke tijd.
params.deltaColumn
De deltakolom wordt vereist om de gegevens te verdelen en nieuw opgenomen gegevens van historische gegevens te scheiden. Nota: deltaColumn is slechts nodig wanneer het creëren van uw eerste stroomlooppas.
params.deltaColumn.name
De naam van de deltakolom.

Reactie

Een geslaagde reactie retourneert de details van de nieuw gemaakte flow, inclusief de unieke run id .

{
    "items": [
        {
            "id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
            "etag": "\"1100c53e-0000-0200-0000-627138980000\""
        }
    ]
}
Eigenschap
Beschrijving
id
De id van de nieuwe flow-run. Zie de gids bij ​ het terugwinnen van stroomspecificaties ​ voor meer informatie over op lijst-gebaseerde looppas specificaties.
etag
De middelversie van de stroomlooppas.

Een doorloop maken voor een op een bestand gebaseerde bron

Als u een stroom voor een op een bestand gebaseerde bron wilt maken, dient u een POST-aanvraag in bij de Flow Service API en geeft u de id op van de flow waarop u de runtime en waarden voor de begintijd en eindtijd wilt maken.

TIP
Bestandsbronnen omvatten alle bronnen voor cloudopslag.

API formaat

POST /runs/

Verzoek

Met de volgende aanvraag wordt een flowuitvoering voor de flow-id 3abea21c-7e36-4be1-bec1-d3bad0e3e0de gemaakt.

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
Beschrijving
flowId
De id van de flow waarop de flow wordt uitgevoerd.
params.startTime
De geplande tijd van wanneer de de stroomlooppas op bestelling zal beginnen. Deze waarde wordt uitgedrukt in unieke tijd.
params.windowStartTime
De vroegste datum en tijd waarop de gegevens worden opgehaald. Deze waarde wordt uitgedrukt in unieke tijd.
params.windowEndTime
De datum en tijd waarop de gegevens worden opgehaald tot. Deze waarde wordt uitgedrukt in unieke tijd.

Reactie

Een geslaagde reactie retourneert de details van de nieuw gemaakte flow, inclusief de unieke run id .

{
    "items": [
        {
            "id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
            "etag": "\"1100c53e-0000-0200-0000-627138980000\""
        }
    ]
}
Eigenschap
Beschrijving
id
De id van de nieuwe flow-run. Zie de gids bij ​ het terugwinnen van stroomspecificaties ​ voor meer informatie over op lijst-gebaseerde looppas specificaties.
etag
De middelversie van de stroomlooppas.

De stroomuitvoering controleren

Zodra uw stroomlooppas is gecreeerd, kunt u de gegevens controleren die door het worden opgenomen om informatie over stroomlooppas, voltooiingsstatus, en fouten te zien. Om uw stroomlooppas te controleren die API gebruiken, zie het leerprogramma op ​ controledataflows in API ​. Om uw stroomlooppas te controleren die Experience Platform UI gebruiken, zie de gids op ​ gegevensstroom controlemogelijkheden gebruikend het controledashboard ​.

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