DocumentaçãoExperience PlatformGuia de destinos

Configuração em lote batch-configuration

Última atualização: 16 de setembro de 2026

Criado para:

  • Usuário
  • Admin

Use as opções de configuração em lote no Destination SDK para permitir que os usuários personalizem os nomes de 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 do Experience Platform. Por exemplo, você pode configurar comportamentos como:

  • Inclua 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 nomenclatura de arquivos na interface do usuário do Experience Platform.
  • Configure as exportações de arquivos para que ocorram em intervalos de tempo definidos.
  • Defina quais opções de nomenclatura de arquivo e de personalização de agendamento de exportação os usuários podem ver na interface do usuário do Experience 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 Experience Platform.

IMPORTANT
Todos os nomes e valores de parâmetros com suporte de Destination SDK diferenciam maiúsculas de minúsculas 2}. 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

batchConfig vs. datasetBatchConfig batchconfig-vs-datasetbatchconfig

Esta página descreve dois objetos de configuração relacionados, mas distintos:

  • batchConfig: Controla as configurações de nomenclatura de arquivos e agenda de exportação para destinos que exportam públicos-alvo (pessoas, contas ou públicos-alvo potenciais).
  • datasetBatchConfig: um objeto aninhado dentro de batchConfig que controla a nomenclatura da pasta e as configurações de agenda de exportação especificamente para destinos que exportam conjuntos de dados. Use essa opção quando o destino oferecer suporte a exportações de conjunto de dados (ou seja, "sources": ["DATASETS"] está definido na sua configuração de destino).

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",
   "allowedExportModes":[
      "DAILY_FULL_EXPORT",
      "FIRST_FULL_THEN_INCREMENTAL"
   ],
   "allowedScheduleFrequency":[
      "DAILY",
      "EVERY_3_HOURS",
      "EVERY_6_HOURS",
      "EVERY_8_HOURS",
      "EVERY_12_HOURS",
      "ONCE",
      "WEEKLY",
      "MONTHLY"
   ],
   "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
Lista Discriminada

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
  • WEEKLY
  • MONTHLY
defaultFrequency
Lista Discriminada

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

  • ONCE
  • EVERY_3_HOURS
  • EVERY_6_HOURS
  • EVERY_8_HOURS
  • EVERY_12_HOURS
  • DAILY
  • WEEKLY
  • MONTHLY

O valor padrão é DAILY.

defaultStartTime
String
Define a hora de início padrão da exportação de arquivos. Usa o formato 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 usuário 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 completamente.

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 Experience 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 Experience 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 em 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 file-name-configuration-example

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

Configuração de exportação do conjunto de dados dataset-export-configuration

Use o objeto datasetBatchConfig, aninhado dentro de batchConfig, para configurar a nomenclatura da pasta e os agendamentos de exportação para destinos que oferecem suporte a exportações do conjunto de dados.

IMPORTANT
Esse objeto só é aplicável quando a configuração de destino inclui "sources": ["DATASETS"]. Consulte Configurar tipo de dados de público-alvo para obter o exemplo completo de configuração de destino, ou siga o guia passo a passo para configurar um destino de exportação do conjunto de dados.
"batchConfig":{
   "datasetBatchConfig":{
      "allowedFoldernameAppendOptions":[
         "DESTINATION",
         "DATASET_ID",
         "DATASET_NAME",
         "EXPORT_TIME",
         "DESTINATION_INSTANCE_ID",
         "DESTINATION_INSTANCE_NAME",
         "ORGANIZATION_NAME",
         "SANDBOX_NAME",
         "DATETIME",
         "CUSTOM_TEXT"
      ],
      "defaultFoldernameAppendOptions":[
         "DATASET_ID",
         "EXPORT_TIME"
      ],
      "allowedExportModes":[
         "DAILY_FULL_EXPORT",
         "FIRST_FULL_THEN_INCREMENTAL"
      ],
      "allowedScheduleFrequency":[
         "DAILY",
         "EVERY_3_HOURS",
         "EVERY_6_HOURS",
         "EVERY_8_HOURS",
         "EVERY_12_HOURS",
         "ONCE"
      ]
   }
}
Parâmetro
Tipo
Descrição
datasetBatchConfig.allowedFoldernameAppendOptions
Lista

Obrigatório. Lista de macros de nome de pasta disponíveis para os usuários escolherem. Eles determinam quais itens são anexados ao caminho da pasta de exportação. Se defaultFoldernameAppendOptions estiver vazio, pelo menos uma macro deve ser especificada aqui. Valores compatíveis:

  • DESTINATION
  • DATASET_ID
  • DATASET_NAME
  • EXPORT_TIME
  • DESTINATION_INSTANCE_ID
  • DESTINATION_INSTANCE_NAME
  • ORGANIZATION_NAME
  • SANDBOX_NAME
  • DATETIME
  • CUSTOM_TEXT
datasetBatchConfig.defaultFoldernameAppendOptions
Lista
Obrigatório. Macros de nome de pasta padrão pré-selecionadas. Deve ser um subconjunto dos valores definidos em allowedFoldernameAppendOptions.
datasetBatchConfig.allowedExportModes
Lista

Define os modos de exportação disponíveis aos usuários para exportações de conjunto de dados. Valores compatíveis:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL
datasetBatchConfig.allowedScheduleFrequency
Lista

Define as opções de frequência de exportação disponíveis aos usuários para exportações de conjunto de dados. Valores compatíveis:

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

Macros do nome da pasta folder-name-macros

As macros na tabela abaixo podem ser usadas em allowedFoldernameAppendOptions e defaultFoldernameAppendOptions para definir a estrutura do caminho da pasta de exportação do conjunto de dados.

Macro
Descrição
Exemplo
DESTINATION
Nome do destino na interface do usuário.
Amazon S3
DATASET_ID
Identificador exclusivo gerado pela Experience Platform do conjunto de dados exportado.
6966075d-f6b4-4a04-bd35-d438e1ebd1c3
DATASET_NAME
Nome do conjunto de dados exportado.
Meu conjunto de dados
EXPORT_TIME
Exportar hora no formato exportTime=YYYYMMDDHHMM.
exportTime=202212091200
DESTINATION_INSTANCE_ID
ID exclusiva gerada pela Experience Platform da instância de destino.
7b891e5f-025a-4f0d-9e73-1919e71da3b0
DESTINATION_INSTANCE_NAME
Nome definido pelo usuário da instância de destino.
Meu destino do Advertising 2024
ORGANIZATION_NAME
Nome da organização do cliente em Adobe Experience Platform.
Nome da Minha Organização
SANDBOX_NAME
Nome da sandbox usada pelo cliente.
prod
DATETIME
Data e hora no formato YYYYMMDD_HHMMSS.
20220509_210543
CUSTOM_TEXT
Texto personalizado definido pelo usuário a ser incluído no nome da pasta.
Meu_Texto_Personalizado

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
experience-platform-help-destinations