DocumentaçãoExperience PlatformGuia de destinos

Configuração em lote batch-configuration

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • undefined
  • undefined

Use as opções de configuração em lote no Destination SDK para permitir que os usuários personalizem os nomes dos arquivos exportados e configurem o agendamento de exportação de acordo com suas preferências.

Ao criar destinos baseados em arquivo por meio do Destination SDK, você pode configurar a nomenclatura de arquivo padrão e os agendamentos de exportação ou pode dar aos usuários a opção de definir essas configurações na interface do usuário da Platform. Por exemplo, você pode configurar comportamentos como:

  • Incluindo informações específicas no nome do arquivo, como IDs de público-alvo, IDs de destino ou informações personalizadas.
  • Permitir que os usuários personalizem a nomeação de arquivos na interface do usuário da Platform.
  • Configure as exportações de arquivos para que ocorram em intervalos de tempo definidos.
  • Defina quais opções de nomenclatura de arquivo e personalização de agendamento de exportação os usuários podem ver na interface do usuário da Platform.

As definições de configuração em lote fazem parte da configuração de destino para destinos baseados em arquivo.

Para entender onde esse componente se encaixa em uma integração criada com o Destination SDK, consulte o diagrama na documentação de opções de configuração ou consulte o guia sobre como usar o Destination SDK para configurar um destino baseado em arquivo.

Você pode definir as configurações de nomenclatura de arquivo e agenda de exportação por meio do ponto de extremidade /authoring/destinations. Consulte as seguintes páginas de referência de API para obter exemplos detalhados de chamadas de API, onde é possível configurar os componentes mostrados nesta página.

Este artigo descreve todas as opções de configuração em lote compatíveis que você pode usar para o seu destino e mostra o que os clientes verão na interface do usuário da Platform.

IMPORTANT
Todos os nomes e valores de parâmetros suportados pelo Destination SDK fazem distinção entre maiúsculas e minúsculas. Para evitar erros de diferenciação entre maiúsculas e minúsculas, use os nomes e valores dos parâmetros exatamente como mostrado na documentação.

Tipos de integração compatíveis supported-integration-types

Consulte a tabela abaixo para obter detalhes sobre quais tipos de integrações suportam a funcionalidade descrita nesta página.

Tipo de integração
Suporte à funcionalidade
Integrações em tempo real (streaming)
Não
Integrações baseadas em arquivo (lote)
Sim

Parâmetros compatíveis supported-parameters

Os valores configurados aqui são exibidos na etapa Agendar exportação de público-alvo do fluxo de trabalho de ativação dos destinos baseados em arquivo.

"batchConfig":{
   "allowMandatoryFieldSelection":true,
   "allowDedupeKeyFieldSelection":true,
   "defaultExportMode":"DAILY_FULL_EXPORT",
   "allowedExportMode":[
      "DAILY_FULL_EXPORT",
      "FIRST_FULL_THEN_INCREMENTAL"
   ],
   "allowedScheduleFrequency":[
      "DAILY",
      "EVERY_3_HOURS",
      "EVERY_6_HOURS",
      "EVERY_8_HOURS",
      "EVERY_12_HOURS",
      "ONCE"
   ],
   "defaultFrequency":"DAILY",
   "defaultStartTime":"00:00",
   "filenameConfig":{
         "allowedFilenameAppendOptions":[
            "SEGMENT_NAME",
            "DESTINATION_INSTANCE_ID",
            "DESTINATION_INSTANCE_NAME",
            "ORGANIZATION_NAME",
            "SANDBOX_NAME",
            "DATETIME",
            "CUSTOM_TEXT"
         ],
         "defaultFilenameAppendOptions":[
            "DATETIME"
         ],
         "defaultFilename":"%DESTINATION%_%SEGMENT_ID%"
      },
   "segmentGroupingEnabled": true
   }
Parâmetro
Tipo
Descrição
allowMandatoryFieldSelection
Booleano
Defina como true para permitir que os clientes especifiquem quais atributos de perfil são obrigatórios. O valor padrão é false. Consulte Atributos obrigatórios para obter mais informações.
allowDedupeKeyFieldSelection
Booleano
Defina como true para permitir que os clientes especifiquem chaves de desduplicação. O valor padrão é false. Consulte Chaves de desduplicação para obter mais informações.
defaultExportMode
Enumeração

Define o modo de exportação de arquivo padrão. Valores compatíveis:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL

O valor padrão é DAILY_FULL_EXPORT. Consulte a documentação de ativação em lote para obter detalhes sobre o agendamento de exportações de arquivos.

allowedExportModes
Lista

Define os modos de exportação de arquivo disponíveis para clientes. Valores compatíveis:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequency
Lista

Define a frequência de exportação de arquivos disponível para os clientes. Valores compatíveis:

  • ONCE
  • EVERY_3_HOURS
  • EVERY_6_HOURS
  • EVERY_8_HOURS
  • EVERY_12_HOURS
  • DAILY
defaultFrequency
Enumeração

Define a frequência de exportação de arquivo padrão. Valores compatíveis:

  • ONCE
  • EVERY_3_HOURS
  • EVERY_6_HOURS
  • EVERY_8_HOURS
  • EVERY_12_HOURS
  • DAILY

O valor padrão é DAILY.

defaultStartTime
String
Define a hora de início padrão da exportação de arquivos. Usa o formato de arquivo de 24 horas. O valor padrão é "00:00".
filenameConfig.allowedFilenameAppendOptions
String

Obrigatório. Lista de macros de nome de arquivo disponíveis para os usuários escolherem. Isso determina quais itens são anexados a nomes de arquivo exportados (ID de público-alvo, nome da organização, data e hora da exportação e outros). Ao configurar defaultFilename, evite a duplicação de macros.

Valores com suporte:

  • DESTINATION
  • SEGMENT_ID
  • SEGMENT_NAME
  • DESTINATION_INSTANCE_ID
  • DESTINATION_INSTANCE_NAME
  • ORGANIZATION_NAME
  • SANDBOX_NAME
  • DATETIME
  • CUSTOM_TEXT

Independentemente da ordem em que você define as macros, a interface do Experience Platform sempre as exibirá na ordem apresentada aqui.

Se defaultFilename estiver vazio, a lista allowedFilenameAppendOptions deverá conter pelo menos uma macro.

filenameConfig.defaultFilenameAppendOptions
String
Obrigatório. Macros de nome de arquivo padrão pré-selecionadas que os usuários podem desmarcar.

As macros nesta lista são um subconjunto das definidas em allowedFilenameAppendOptions.
filenameConfig.defaultFilename
String
Opcional. Define as macros de nome de arquivo padrão para os arquivos exportados. Eles não podem ser substituídos por usuários.

Qualquer macro definida por allowedFilenameAppendOptions será anexada após as defaultFilename macros.

Se defaultFilename estiver vazio, você deverá definir pelo menos uma macro em allowedFilenameAppendOptions.
segmentGroupingEnabled
Booleano

Define se os públicos ativados devem ser exportados em um único arquivo ou em vários arquivos, com base na política de mesclagem do público-alvo. Valores compatíveis:

  • true: exporta um arquivo por política de mesclagem.
  • false: exporta um arquivo por público, independentemente da política de mesclagem. Esse é o comportamento padrão. Você pode obter o mesmo resultado omitindo esse parâmetro totalmente.

Configuração do nome do arquivo file-name-configuration

Use macros de configuração de nome de arquivo para definir o que os nomes de arquivo exportados devem incluir. As macros na tabela abaixo descrevem elementos encontrados na interface do usuário na tela configuração de nome de arquivo.

TIP
Como prática recomendada, você sempre deve incluir a macro SEGMENT_ID nos nomes de arquivos exportados. As IDs de segmento são exclusivas, portanto, incluí-las no nome do arquivo é a melhor maneira de garantir que os nomes de arquivo também sejam exclusivos.
Macro
Rótulo da interface
Descrição
Exemplo
DESTINATION
Destino
Nome do destino na interface do usuário.
Amazon S3
SEGMENT_ID
ID do segmento
ID de público-alvo exclusiva gerada pela Platform
ce5c5482-2813-4a80-99bc-57113f6acde2
SEGMENT_NAME
Nome do segmento
Nome de público definido pelo usuário
Assinante do VIP
DESTINATION_INSTANCE_ID
ID de Destino
ID exclusiva gerada pela Platform da instância de destino
7b891e5f-025a-4f0d-9e73-1919e71da3b0
DESTINATION_INSTANCE_NAME
Nome do Destino
Nome definido pelo usuário da instância de destino.
Meu destino do Advertising 2022
ORGANIZATION_NAME
Nome da Organização
Nome da organização do cliente no Adobe Experience Platform.
Nome da Minha Organização
SANDBOX_NAME
Nome da sandbox
Nome da sandbox usada pelo cliente.
prod
DATETIME / TIMESTAMP
Data e hora

DATETIME e TIMESTAMP definem quando o arquivo foi gerado, mas em formatos diferentes.

  • DATETIME usa o seguinte formato: AAAAMMDD_HHMMSS.
  • TIMESTAMP usa o formato Unix de 10 dígitos.

DATETIME e TIMESTAMP são mutuamente exclusivos e não podem ser usados simultaneamente.

  • DATETIME: 20220509_210543
  • TIMESTAMP: 1652131584
CUSTOM_TEXT
Texto personalizado
Texto personalizado definido pelo usuário a ser incluído no nome do arquivo. Não pode ser usado em defaultFilename.
Meu_Texto_Personalizado
TIMESTAMP
Data e hora
Carimbo de data e hora de 10 dígitos da hora em que o arquivo foi gerado, no formato Unix.
1652131584
MERGE_POLICY_ID
ID da Política de Mesclagem
A ID da política de mesclagem usada para gerar o público exportado. Use essa macro quando estiver agrupando públicos exportados em arquivos, com base na política de mesclagem. Use esta macro junto com segmentGroupingEnabled:true.
e8591fdb-2873-4b12-b63e-15275b1c1439
MERGE_POLICY_NAME
Nome da Política de Mesclagem
O nome da política de mesclagem usada para gerar o público exportado. Use essa macro quando estiver agrupando públicos exportados em arquivos, com base na política de mesclagem. Use esta macro junto com segmentGroupingEnabled:true.
Minha política de mesclagem personalizada

Exemplo de configuração do nome do arquivo

O exemplo de configuração abaixo mostra a correspondência entre a configuração usada na chamada de API e as opções mostradas na interface do usuário.

"filenameConfig":{
   "allowedFilenameAppendOptions":[
      "CUSTOM_TEXT",
      "SEGMENT_ID",
      "DATETIME"
   ],
   "defaultFilenameAppendOptions":[
      "SEGMENT_ID",
      "DATETIME"
   ],
   "defaultFilename": "%DESTINATION%"
}

Imagem da interface do usuário mostrando a tela de configuração de nome de arquivo com macros pré-selecionadas

Próximas etapas next-steps

Depois de ler este artigo, você deverá entender melhor como configurar a nomenclatura de arquivos e os cronogramas de exportação para seus destinos baseados em arquivo.

Para saber mais sobre os outros componentes de destino, consulte os seguintes artigos:

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6