Configuración por lotes batch-configuration
Utilice las opciones de configuración por lotes en Destination SDK para permitir a los usuarios personalizar los nombres de archivo exportados y configurar la programación de exportación según sus preferencias.
Al crear destinos basados en archivos mediante Destination SDK, puede configurar los nombres de archivo predeterminados y las programaciones de exportación, o puede dar a los usuarios la opción de configurar estos ajustes desde la interfaz de usuario de Platform. Por ejemplo, puede configurar comportamientos como:
- Incluir información específica en el nombre del archivo, como ID de audiencia, ID de destino o información personalizada.
- Permite a los usuarios personalizar el nombre de archivo desde la interfaz de usuario de Platform.
- Configure las exportaciones de archivos para que se produzcan a intervalos de tiempo establecidos.
- Defina las opciones de nomenclatura de archivos y de personalización de programación de exportación que los usuarios pueden ver en la IU de Platform.
Los ajustes de configuración por lotes forman parte de la configuración de destino para destinos basados en archivos.
Para saber dónde encaja este componente en una integración creada con Destination SDK, consulte el diagrama en la documentación de opciones de configuración o consulte la guía sobre cómo usar Destination SDK para configurar un destino basado en archivos.
Puede configurar la nomenclatura de archivos y exportar la configuración de programación a través del extremo /authoring/destinations. Consulte las siguientes páginas de referencia de la API para ver ejemplos detallados de llamadas de la API donde puede configurar los componentes que se muestran en esta página.
Este artículo describe todas las opciones de configuración por lotes admitidas que puede utilizar para su destino y muestra lo que los clientes verán en la interfaz de usuario de Platform.
Tipos de integración admitidos supported-integration-types
Consulte la tabla siguiente para obtener detalles sobre qué tipos de integraciones admiten la funcionalidad descrita en esta página.
Parámetros admitidos supported-parameters
Los valores que configuró aquí aparecen en el paso Programar exportación de audiencias del flujo de trabajo de activación de destinos basados en archivos.
"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
}
allowMandatoryFieldSelectiontrue para permitir que los clientes especifiquen qué atributos de perfil son obligatorios. El valor predeterminado es false. Consulte Atributos obligatorios para obtener más información.allowDedupeKeyFieldSelectiontrue para permitir que los clientes especifiquen las claves de anulación de duplicación. El valor predeterminado es false. Consulte Claves de deduplicación para obtener más información.defaultExportModeDefine el modo de exportación de archivos predeterminado. Valores compatibles:
DAILY_FULL_EXPORTFIRST_FULL_THEN_INCREMENTAL
El valor predeterminado es DAILY_FULL_EXPORT. Consulte la documentación de activación por lotes para obtener detalles acerca de la programación de exportaciones de archivos.
allowedExportModesDefine los modos de exportación de archivos disponibles para los clientes de. Valores compatibles:
DAILY_FULL_EXPORTFIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequencyDefine la frecuencia de exportación de archivos disponible para los clientes. Valores compatibles:
ONCEEVERY_3_HOURSEVERY_6_HOURSEVERY_8_HOURSEVERY_12_HOURSDAILY
defaultFrequencyDefine la frecuencia predeterminada de exportación de archivos. Valores compatibles:
ONCEEVERY_3_HOURSEVERY_6_HOURSEVERY_8_HOURSEVERY_12_HOURSDAILY
El valor predeterminado es DAILY.
defaultStartTimefilenameConfig.allowedFilenameAppendOptionsRequerido. Lista de macros de nombre de archivo disponibles para que los usuarios elijan. Esto determina qué elementos se anexan a los nombres de archivo exportados (ID de audiencia, nombre de organización, fecha y hora de exportación, etc.). Al establecer defaultFilename, asegúrese de evitar la duplicación de macros.
Valores compatibles:
DESTINATIONSEGMENT_IDSEGMENT_NAMEDESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIMECUSTOM_TEXT
Independientemente del orden en el que defina las macros, la interfaz de usuario de Experience Platform siempre las mostrará en el orden presentado aquí.
Si defaultFilename está vacío, la lista allowedFilenameAppendOptions debe contener al menos una macro.
filenameConfig.defaultFilenameAppendOptionsLas macros de esta lista son un subconjunto de las definidas en
allowedFilenameAppendOptions.filenameConfig.defaultFilenameCualquier macro definida por
allowedFilenameAppendOptions se anexará después de las macros defaultFilename.Si
defaultFilename está vacío, debe definir al menos una macro en allowedFilenameAppendOptions.segmentGroupingEnabledDefine si las audiencias activadas deben exportarse en un solo archivo o en varios, según la audiencia política de combinación. Valores compatibles:
true: exporta un archivo por política de combinación.false: exporta un archivo por audiencia, independientemente de la política de combinación. Este es el comportamiento predeterminado. Puede lograr el mismo resultado omitiendo este parámetro por completo.
Configuración del nombre de archivo file-name-configuration
Utilice macros de configuración de nombres de archivo para definir qué nombres de archivo exportados deben incluir. Las macros de la tabla siguiente describen los elementos que se encuentran en la interfaz de usuario de la pantalla configuración de nombre de archivo.
SEGMENT_ID en los nombres de archivo exportados. Los ID de segmento son únicos, por lo que incluirlos en el nombre de archivo es la mejor manera de asegurarse de que los nombres de archivo también sean únicos.DESTINATIONSEGMENT_IDSEGMENT_NAMEDESTINATION_INSTANCE_IDDESTINATION_INSTANCE_NAMEORGANIZATION_NAMESANDBOX_NAMEDATETIME / TIMESTAMPDATETIME y TIMESTAMP definen cuándo se generó el archivo, pero en formatos diferentes.
DATETIMEusa el siguiente formato: AAAAMMDD_HHMMSS.TIMESTAMPusa el formato Unix de 10 dígitos.
DATETIME y TIMESTAMP se excluyen mutuamente y no se pueden usar simultáneamente.
DATETIME: 20220509_210543TIMESTAMP: 1652131584
CUSTOM_TEXTdefaultFilename.TIMESTAMPMERGE_POLICY_IDsegmentGroupingEnabled:true.MERGE_POLICY_NAMEsegmentGroupingEnabled:true.Ejemplo de configuración de nombre de archivo
El ejemplo de configuración siguiente muestra la correspondencia entre la configuración utilizada en la llamada de API y las opciones que se muestran en la interfaz de usuario.
"filenameConfig":{
"allowedFilenameAppendOptions":[
"CUSTOM_TEXT",
"SEGMENT_ID",
"DATETIME"
],
"defaultFilenameAppendOptions":[
"SEGMENT_ID",
"DATETIME"
],
"defaultFilename": "%DESTINATION%"
}
Pasos siguientes next-steps
Después de leer este artículo, debería tener una mejor comprensión de cómo puede configurar la nomenclatura de archivos y las programaciones de exportación para sus destinos basados en archivos.
Para obtener más información acerca de los demás componentes de destino, consulte los siguientes artículos:
- Configuración de autenticación del cliente
- Autorización de OAuth2
- Campos de datos del cliente
- Atributos de IU
- Configuración del esquema
- Configuración del área de nombres de identidad
- Configuraciones de asignación compatibles
- Envío de destino
- Configuración de metadatos de audiencia
- Política de agregación
- Cualificaciones históricas del perfil