Crie uma execução de fluxo para assimilação sob demanda usando o Flow Service API

Última atualização em 2023-09-29
  • Tópicos
  • Sources
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer
    User
    Admin
    Leader

As execuções de fluxo representam uma instância da execução de fluxo. Por exemplo, se um fluxo estiver programado para ser executado por hora às 9h, 10h e 11h, você terá três instâncias de um fluxo em execução. As execuções de fluxo são específicas para sua organização específica.

A assimilação sob demanda oferece a capacidade de criar uma execução de fluxo em relação a um determinado fluxo de dados. Isso permite que seus usuários criem uma execução de fluxo, com base em determinados parâmetros, e criem um ciclo de assimilação, sem tokens de serviço. O suporte para assimilação sob demanda está disponível somente para origens em lote.

Este tutorial aborda as etapas sobre como usar a assimilação sob demanda e criar uma execução de fluxo usando o Flow Service API.

Introdução

OBSERVAÇÃO

Para criar uma execução de fluxo, primeiro você deve ter a ID de fluxo de um fluxo de dados programado para assimilação única.

Este tutorial requer que você tenha uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:

  • Origens: Experience Platform O permite que os dados sejam assimilados de várias fontes e, ao mesmo tempo, fornece a capacidade de estruturar, rotular e aprimorar os dados recebidos usando o Platform serviços.
  • Sandboxes: Experience Platform O fornece sandboxes virtuais que particionam uma única Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

Uso de APIs da plataforma

Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual em introdução às APIs da Platform.

Criar uma execução de fluxo para uma origem baseada em tabela

Para criar um fluxo para uma origem baseada em tabela, faça uma solicitação POST para o Flow Service API enquanto fornece a ID do fluxo em que você deseja criar a execução, bem como valores para hora de início, hora de término e coluna delta.

DICA

As fontes baseadas em tabela incluem as seguintes categorias de fonte: publicidade, análises, consentimento e preferências, CRMs, sucesso do cliente, banco de dados, automação de marketing, pagamentos e protocolos.

Formato da API

POST /runs/

Solicitação

A solicitação a seguir cria uma execução de fluxo para a ID do fluxo 3abea21c-7e36-4be1-bec1-d3bad0e3e0de.

OBSERVAÇÃO

Você só precisa fornecer a deltaColumn ao criar sua primeira execução de fluxo. Depois disso, deltaColumn será corrigido como parte de copy transformação no fluxo e serão tratados como a fonte da verdade. Qualquer tentativa de alterar a deltaColumn por meio dos parâmetros de execução de fluxo resultará em um erro.

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"
          }
      }
  }'
Parâmetro Descrição
flowId A ID do fluxo no qual a execução do fluxo será criada.
params.startTime O horário agendado para o início da execução do fluxo por demanda. Esse valor é representado no horário unix.
params.windowStartTime A data e a hora a partir das quais os dados serão recuperados. Esse valor é representado no horário unix.
params.windowEndTime A data e a hora em que os dados serão recuperados. Esse valor é representado no horário unix.
params.deltaColumn A coluna delta é necessária para particionar os dados e separar os dados recém-assimilados dos dados históricos. Nota: A variável deltaColumn é necessário somente ao criar a primeira execução de fluxo.
params.deltaColumn.name O nome da coluna delta.

Resposta

Uma resposta bem-sucedida retorna os detalhes da execução de fluxo recém-criada, incluindo sua execução exclusiva id.

{
    "items": [
        {
            "id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
            "etag": "\"1100c53e-0000-0200-0000-627138980000\""
        }
    ]
}
Propriedade Descrição
id A ID da execução do fluxo recém-criado. Consulte o guia sobre recuperação de especificações de fluxo para obter mais informações sobre especificações de execução baseadas em tabela.
etag A versão do recurso da execução do fluxo.

Criar uma execução de fluxo para uma origem baseada em arquivo

Para criar um fluxo para uma origem baseada em arquivo, faça uma solicitação POST para a Flow Service Ao fornecer a ID do fluxo em que você deseja criar a execução e os valores para a hora de início e de término.

DICA

As fontes baseadas em arquivo incluem todas as fontes de armazenamento na nuvem.

Formato da API

POST /runs/

Solicitação

A solicitação a seguir cria uma execução de fluxo para a ID do fluxo 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"
      }
  }'
Parâmetro Descrição
flowId A ID do fluxo no qual a execução do fluxo será criada.
params.startTime O horário agendado para o início da execução do fluxo por demanda. Esse valor é representado no horário unix.
params.windowStartTime A data e a hora a partir das quais os dados serão recuperados. Esse valor é representado no horário unix.
params.windowEndTime A data e a hora em que os dados serão recuperados. Esse valor é representado no horário unix.

Resposta

Uma resposta bem-sucedida retorna os detalhes da execução de fluxo recém-criada, incluindo sua execução exclusiva id.

{
    "items": [
        {
            "id": "3fb0418e-1804-45d6-8d56-dd51f05c0baf",
            "etag": "\"1100c53e-0000-0200-0000-627138980000\""
        }
    ]
}
Propriedade Descrição
id A ID da execução do fluxo recém-criado. Consulte o guia sobre recuperação de especificações de fluxo para obter mais informações sobre especificações de execução baseadas em tabela.
etag A versão do recurso da execução do fluxo.

Monitore as execuções de fluxo

Após a criação da execução do fluxo, é possível monitorar os dados que estão sendo assimilados por meio dela para ver informações sobre execuções de fluxo, status de conclusão e erros. Para monitorar as execuções de fluxo usando a API, consulte o tutorial em monitoramento de fluxos de dados na API. Para monitorar suas execuções de fluxo usando a interface do usuário da Platform, consulte o manual em monitoramento de fluxos de dados de origens usando o painel de monitoramento.

Nesta página