Documentación Experience Platform Guía de destinos

Configuración por lotes batch-configuration

Last update: Tue Nov 07 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Temas:
Destinations

Creado para:

Admin
User

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 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 mediante el /authoring/destinations punto final. 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.

IMPORTANT

Todos los nombres y valores de parámetro admitidos por el Destination SDK son distingue mayúsculas de minúsculas. Para evitar errores de distinción entre mayúsculas y minúsculas, utilice los nombres y valores de los parámetros exactamente como se muestra en la documentación.

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.

Tipo de integración

Admite funcionalidad

Integraciones en tiempo real (streaming)

Integraciones basadas en archivos (por lotes)

Sí

Parámetros admitidos supported-parameters

Los valores que configure aquí aparecen en la variable Programar exportación de audiencias paso 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
   }

Parámetro

Tipo

Descripción

allowMandatoryFieldSelection

Booleano

Configure como. true para permitir a los clientes especificar qué atributos de perfil son obligatorios. El valor predeterminado es false. Consulte Atributos obligatorios para obtener más información.

allowDedupeKeyFieldSelection

Booleano

Configure como. true para permitir a los clientes especificar claves de deduplicación. El valor predeterminado es false. Consulte Claves de deduplicación para obtener más información.

defaultExportMode

Enumeración

Define el modo de exportación de archivos predeterminado. Valores compatibles:

DAILY_FULL_EXPORT
FIRST_FULL_THEN_INCREMENTAL

El valor predeterminado es DAILY_FULL_EXPORT. Consulte la documentación de activación por lotes para obtener más información sobre la programación de exportaciones de archivos.

allowedExportModes

Lista

Define los modos de exportación de archivos disponibles para los clientes de. Valores compatibles:

DAILY_FULL_EXPORT
FIRST_FULL_THEN_INCREMENTAL

allowedScheduleFrequency

Lista

Define la frecuencia de exportación de archivos disponible para los clientes. Valores compatibles:

ONCE
EVERY_3_HOURS
EVERY_6_HOURS
EVERY_8_HOURS
EVERY_12_HOURS
DAILY

defaultFrequency

Enumeración

Define la frecuencia predeterminada de exportación de archivos. Valores compatibles:

ONCE
EVERY_3_HOURS
EVERY_6_HOURS
EVERY_8_HOURS
EVERY_12_HOURS
DAILY

El valor predeterminado es DAILY.

defaultStartTime

Cadena

Define la hora de inicio predeterminada para la exportación de archivos. Utiliza el formato de archivo de 24 horas. El valor predeterminado es 00:00.

filenameConfig.allowedFilenameAppendOptions

Cadena

Requerido. 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 configurar defaultFilename, asegúrese de evitar la duplicación de macros.

Valores compatibles:

DESTINATION
SEGMENT_ID
SEGMENT_NAME
DESTINATION_INSTANCE_ID
DESTINATION_INSTANCE_NAME
ORGANIZATION_NAME
SANDBOX_NAME
DATETIME
CUSTOM_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í.

If defaultFilename está vacío, la variable allowedFilenameAppendOptions La lista debe contener al menos una macro.

filenameConfig.defaultFilenameAppendOptions

Cadena

Requerido. Macros de nombre de archivo predeterminado preseleccionadas que los usuarios pueden desmarcar.

Las macros de esta lista son un subconjunto de las definidas en allowedFilenameAppendOptions.

filenameConfig.defaultFilename

Cadena

Opcional. Define las macros de nombre de archivo predeterminadas para los archivos exportados. Los usuarios no pueden sobrescribirlos.

Cualquier macro definida por allowedFilenameAppendOptions se adjuntará después de defaultFilename macros.

If defaultFilename está vacío, debe definir al menos una macro en allowedFilenameAppendOptions.

segmentGroupingEnabled

Booleano

Define si las audiencias activadas deben exportarse en un solo archivo o en varios archivos, 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 configuración de nombre de archivo pantalla.

TIP

Como práctica recomendada, siempre debe incluir la variable SEGMENT_ID macro 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.

Macro

Etiqueta de IU

Descripción

Ejemplo

DESTINATION

Destino

Nombre del destino en la interfaz de usuario.

Amazon S3

SEGMENT_ID

ID del segmento

ID de audiencia único y generado por la plataforma

ce5c5482-2813-4a80-99bc-57113f6acde2

SEGMENT_NAME

Nombre del segmento

Nombre de audiencia definido por el usuario

VIP suscriptor del servicio de asistencia

DESTINATION_INSTANCE_ID

ID de destino

ID único y generado por Platform de la instancia de destino

7b891e5f-025a-4f0d-9e73-1919e71da3b0

DESTINATION_INSTANCE_NAME

Nombre del destino

Nombre definido por el usuario de la instancia de destino.

Mi destino publicitario de 2022

ORGANIZATION_NAME

Nombre de la organización

Nombre de la organización del cliente en Adobe Experience Platform.

Nombre de mi organización

SANDBOX_NAME

Nombre de la zona protegida

Nombre de la zona protegida utilizada por el cliente.

picar

DATETIME / TIMESTAMP

Fecha y hora

DATETIME y TIMESTAMP ambos definen cuándo se generó el archivo, pero en formatos diferentes.

DATETIME utiliza el siguiente formato: AAAAMMDD_HHMMSS.
TIMESTAMP utiliza el formato Unix de 10 dígitos.

DATETIME y TIMESTAMP son mutuamente excluyentes y no pueden utilizarse simultáneamente.

DATETIME: 20220509_210543
TIMESTAMP: 1652131584

CUSTOM_TEXT

Texto personalizado

Texto personalizado definido por el usuario que se incluirá en el nombre del archivo. No se puede usar en defaultFilename.

My_Custom_Text

TIMESTAMP

Fecha y hora

Marca de tiempo de 10 dígitos de la hora en la que se generó el archivo, en formato Unix.

1652131584

MERGE_POLICY_ID

ID de política de combinación

El ID del política de combinación se utiliza para generar la audiencia exportada. Utilice esta macro cuando agrupe audiencias exportadas en archivos, según la política de combinación. Utilice esta macro junto con segmentGroupingEnabled:true.

e8591fdb-2873-4b12-b63e-15275b1c1439

MERGE_POLICY_NAME

Nombre de política de combinación

El nombre del política de combinación se utiliza para generar la audiencia exportada. Utilice esta macro cuando agrupe audiencias exportadas en archivos, según la política de combinación. Utilice esta macro junto con segmentGroupingEnabled:true.

Mi política de combinación personalizada

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%"
}

Imagen de la interfaz de usuario que muestra la pantalla de configuración del nombre de archivo con macros preseleccionadas

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:

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6