Créez une exécution de flux pour l’ingestion à la demande à l’aide de l’API Flow Service

Les exécutions de flux représentent une instance d’exécution de flux. Par exemple, si un flux est planifié pour s’exécuter toutes les heures à 9 h, 10 h et 11 h, vous disposez de trois instances d’exécution de flux. Les exécutions de flux sont spécifiques à votre organisation.

L’ingestion à la demande vous permet de créer une exécution de flux pour un flux de données donné. Cela permet à vos utilisateurs de créer une exécution de flux, en fonction de paramètres donnés, et de créer un cycle d’ingestion, sans jetons de service. La prise en charge de l’ingestion à la demande est disponible uniquement pour les sources par lots.

Ce tutoriel décrit les étapes à suivre pour utiliser l’ingestion à la demande et créer une exécution de flux à l’aide de l’API Flow Service.

Commencer

NOTE
Pour créer une exécution de flux, vous devez d’abord disposer de l’identifiant de flux d’un flux de données planifié pour une ingestion unique.

Ce tutoriel nécessite une compréhension du fonctionnement des composants suivants d’Adobe Experience Platform :

  • Sources: Experience Platformpermet d’ingérer des données provenant de diverses sources tout en vous offrant la possibilité de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide des services Experience Platform.
  • Sandbox : Experience Platform fournit des sandbox virtuels qui divisent une instance Experience Platform unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience digitale.

Utilisation des API Experience Platform

Pour plus d’informations sur la manière d’effectuer avec succès des appels vers les API Experience Platform, consultez le guide Prise en main des API Experience Platform.

Créer une exécution de flux pour une source basée sur un tableau

Pour créer un flux pour une source basée sur un tableau, envoyez une requête POST à l’API Flow Service et indiquez l’identifiant du flux sur lequel vous souhaitez créer l’exécution, ainsi que les valeurs de l’heure de début, de l’heure de fin et de la colonne delta.

TIP
Les sources basées sur des tableaux incluent les catégories de sources suivantes : publicité, analyse, consentement et préférences, CRM, succès client, base de données, automatisation du marketing, paiements et protocoles.

Format d’API

POST /runs/

Requête

La requête suivante crée une exécution de flux pour l’ID de flux 3abea21c-7e36-4be1-bec1-d3bad0e3e0de.

NOTE
Il vous suffit de fournir la deltaColumn lors de la création de votre première exécution de flux. Ensuite, les deltaColumn seront corrigées dans le cadre de copy transformation du flux et traitées comme la source de vérité. Toute tentative de modification de la valeur de deltaColumn par le biais des paramètres d’exécution de flux entraînera une erreur.
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"
          }
      }
  }'
Paramètre
Description
flowId
L’identifiant du flux sur lequel votre exécution de flux sera créée.
params.startTime
Heure planifiée à laquelle l’exécution du flux à la demande commencera. Cette valeur est représentée en temps Unix.
params.windowStartTime
Date et heure au plus tôt à partir desquelles les données seront récupérées. Cette valeur est représentée en temps Unix.
params.windowEndTime
Date et heure de récupération des données. Cette valeur est représentée en temps Unix.
params.deltaColumn
La colonne delta est nécessaire pour partitionner les données et séparer les données nouvellement ingérées des données historiques. Remarque : la deltaColumn n’est nécessaire que lors de la création de votre première exécution de flux.
params.deltaColumn.name
Nom de la colonne delta.

Réponse

Une réponse réussie renvoie les détails de l’exécution de flux nouvellement créée, y compris son id d’exécution unique.

{
    "items": [
        {
            "id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
            "etag": "\"1100c53e-0000-0200-0000-627138980000\""
        }
    ]
}
Propriété
Description
id
Identifiant de l’exécution de flux nouvellement créée. Consultez le guide sur la récupération des spécifications de flux pour plus d’informations sur les spécifications d’exécution basées sur un tableau.
etag
Version des ressources de l’exécution du flux.

Créer une exécution de flux pour une source basée sur des fichiers

Pour créer un flux pour une source basée sur des fichiers, envoyez une requête POST à l’API Flow Service et indiquez l’identifiant du flux sur lequel vous souhaitez créer l’exécution ainsi que les valeurs de l’heure de début et de fin.

TIP
Les sources basées sur des fichiers incluent toutes les sources d’espace de stockage dans le cloud.

Format d’API

POST /runs/

Requête

La requête suivante crée une exécution de flux pour l’ID de flux 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"
      }
  }'
Paramètre
Description
flowId
L’identifiant du flux sur lequel votre exécution de flux sera créée.
params.startTime
Heure planifiée à laquelle l’exécution du flux à la demande commencera. Cette valeur est représentée en temps Unix.
params.windowStartTime
Date et heure au plus tôt à partir desquelles les données seront récupérées. Cette valeur est représentée en temps Unix.
params.windowEndTime
Date et heure de récupération des données. Cette valeur est représentée en temps Unix.

Réponse

Une réponse réussie renvoie les détails de l’exécution de flux nouvellement créée, y compris son id d’exécution unique.

{
    "items": [
        {
            "id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
            "etag": "\"1100c53e-0000-0200-0000-627138980000\""
        }
    ]
}
Propriété
Description
id
Identifiant de l’exécution de flux nouvellement créée. Consultez le guide sur la récupération des spécifications de flux pour plus d’informations sur les spécifications d’exécution basées sur un tableau.
etag
Version des ressources de l’exécution du flux.

Surveiller les exécutions de flux

Une fois votre exécution de flux créée, vous pouvez surveiller les données ingérées pour afficher des informations sur les exécutions de flux, l’état d’achèvement et les erreurs. Pour surveiller vos exécutions de flux à l’aide de l’API , consultez le tutoriel sur la surveillance des flux de données dans l’API. Pour surveiller vos exécutions de flux à l’aide de l’interface utilisateur d’Experience Platform, consultez le guide sur la surveillance des flux de données sources à l’aide du tableau de bord de surveillance.

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