Documentación Experience Platform Guía de destinos

Configuración de formato de archivo

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

Temas:
Destinos

Creado para:

Administrador
Usuario

Destination SDK admite un conjunto flexible de funciones que puede configurar según sus necesidades de integración. Entre estas características se encuentra la compatibilidad con el formato de archivo CSV.

Al crear destinos basados en archivos mediante Destination SDK, puede definir el formato de los archivos CSV exportados. Puede personalizar muchas opciones de formato, como, entre otras:

Si el archivo CSV debe incluir un encabezado;
Qué carácter utilizar para citar valores;
Aspecto que deben tener los valores vacíos.

Según la configuración de destino, los usuarios verán ciertas opciones en la interfaz de usuario al conectarse a un destino basado en archivos. Puede ver el aspecto de estas opciones en la documentación de opciones de formato de archivo para destinos basados en archivos.

La configuración de formato de archivo forma parte de la configuración del servidor 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 las opciones de formato de archivo a través del extremo /authoring/destination-servers. 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.

Esta página describe todos los valores de formato de archivo admitidos para los archivos CSV exportados.

IMPORTANT

Todos los nombres y valores de parámetro admitidos por el Destination SDK distinguen entre mayúsculas y minúsculas 1}. 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

Puede modificar varias propiedades de los archivos exportados para que coincidan con los requisitos del sistema de recepción de archivos del destino, de modo que se lean e interpreten de forma óptima los archivos recibidos del Experience Platform.

NOTE

Las opciones CSV solo se admiten al exportar archivos CSV. La sección fileConfigurations no es obligatoria al configurar un nuevo servidor de destino. Si no pasa ningún valor en la llamada de API para las opciones de CSV, se usarán los valores predeterminados de la tabla de referencia más abajo.

Opciones de CSV donde los usuarios no pueden seleccionar opciones de configuración file-configuration-templating-none

En el siguiente ejemplo de configuración, todas las opciones de CSV están predefinidas. La configuración de exportación definida en cada uno de los parámetros csvOptions es final y los usuarios no pueden modificarla.

"fileConfigurations": {
        "compression": {
            "templatingStrategy": "PEBBLE_V1",
            "value": "{{customerData.compression}}"
        },
        "fileType": {
            "templatingStrategy": "PEBBLE_V1",
            "value": "{{customerData.fileType}}"
        },
        "csvOptions": {
            "quote": {
                "templatingStrategy": "NONE",
                "value": "\""
            },
            "quoteAll": {
                "templatingStrategy": "NONE",
                "value": "false"
            },
            "escape": {
                "templatingStrategy": "NONE",
                "value": "\\"
            },
            "escapeQuotes": {
                "templatingStrategy": "NONE",
                "value": "true"
            },
            "header": {
                "templatingStrategy": "NONE",
                "value": "true"
            },
            "ignoreLeadingWhiteSpace": {
                "templatingStrategy": "NONE",
                "value": "true"
            },
            "ignoreTrailingWhiteSpace": {
                "templatingStrategy": "NONE",
                "value": "true"
            },
            "nullValue": {
                "templatingStrategy": "NONE",
                "value": ""
            },
            "dateFormat": {
                "templatingStrategy": "NONE",
                "value": "yyyy-MM-dd"
            },
            "timestampFormat": {
                "templatingStrategy": "NONE",
                "value": "yyyy-MM-dd'T':mm:ss[.SSS][XXX]"
            },
            "charToEscapeQuoteEscaping": {
                "templatingStrategy": "NONE",
                "value": "\\"
            },
            "emptyValue": {
                "templatingStrategy": "NONE",
                "value": ""
            }
        },
        "maxFileRowCount":5000000,
        "includeFileManifest": {
            "templatingStrategy":"PEBBLE_V1",
            "value":"{{ customerData.includeFileManifest }}"
      }
    }

Opciones de CSV donde los usuarios pueden seleccionar opciones de configuración file-configuration-templating-pebble

En el ejemplo de configuración que se muestra a continuación, ninguna de las opciones de CSV está predefinida. El value en cada uno de los parámetros csvOptions se configura en un campo de datos del cliente correspondiente a través del extremo /destinations (por ejemplo, customerData.quote para la opción de formato de archivo quote) y los usuarios pueden utilizar la interfaz de usuario del Experience Platform para seleccionar entre las distintas opciones que configure en el campo de datos del cliente correspondiente. Puede ver el aspecto de estas opciones en la documentación de opciones de formato de archivo para destinos basados en archivos.

{
   "fileConfigurations":{
      "compression":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{% if customerData contains 'compression' and customerData.compression is not empty %}{{customerData.compression}}{% else %}NONE{% endif %}"
      },
      "fileType":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.fileType}}"
      },
      "csvOptions":{
         "sep":{
            "templatingStrategy":"PEBBLE_V1",
            "value":"{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'delimiter' %}{{customerData.csvOptions.delimiter}}{% else %},{% endif %}"
         },
         "quote":{
            "templatingStrategy":"PEBBLE_V1",
            "value":"{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'quote' %}{{customerData.csvOptions.quote}}{% else %}\"{% endif %}"
         },
         "escape":{
            "templatingStrategy":"PEBBLE_V1",
            "value":"{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'escape' %}{{customerData.csvOptions.escape}}{% else %}\\{% endif %}"
         },
         "nullValue":{
            "templatingStrategy":"PEBBLE_V1",
            "value":"{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'nullValue' %}{{customerData.csvOptions.nullValue}}{% else %}null{% endif %}"
         },
         "emptyValue":{
            "templatingStrategy":"PEBBLE_V1",
            "value":"{% if customerData contains 'csvOptions' and customerData.csvOptions contains 'emptyValue' %}{{customerData.csvOptions.emptyValue}}{% else %}{% endif %}"
         }
      },
      "maxFileRowCount":5000000,
      "includeFileManifest": {
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{ customerData.includeFileManifest }}"
      }
   }
}

Referencia completa y ejemplos de las opciones de formato de archivo compatibles file-formatting-reference-and-example

TIP

Las opciones de formato de archivo CSV que se describen a continuación también están documentadas en la guía de Apache Spark para archivos CSV. Las descripciones utilizadas a continuación se toman de la guía de Apache Spark.

A continuación se muestra una referencia completa de todas las opciones de formato de archivo disponibles en Destination SDK, junto con ejemplos de salida para cada opción.

Campo

Obligatorio/Opcional

Descripción

Valor predeterminado

Ejemplo de salida 1

Ejemplo de salida 2

templatingStrategy

Requerido

Para cada opción de formato de archivo que configure, debe agregar el parámetro templatingStrategy, que puede tener dos valores:

NONE: utilice este valor si no planea permitir que los usuarios seleccionen entre valores diferentes para una configuración. Consulte esta configuración para ver un ejemplo en el que las opciones de formato de archivo están fijas.
PEBBLE_V1: utilice este valor si desea permitir que los usuarios seleccionen entre valores diferentes para una configuración. En este caso, también debe configurar un campo de datos del cliente correspondiente en la configuración del extremo /destination, para que aparezcan las distintas opciones para los usuarios en la interfaz de usuario. Consulte esta configuración para ver un ejemplo en el que los usuarios pueden seleccionar entre valores diferentes para las opciones de formato de archivo.

compression.value

Opcional

Códec de compresión que se utilizará al guardar datos en un archivo. Valores compatibles: none, bzip2, gzip, lz4 y snappy.

none

fileType.value

Opcional

Especifica el formato del archivo de salida. Valores compatibles: csv, parquet y json.

csv

csvOptions.quote.value

Opcional

Solo para"fileType.value": "csv". Establece un solo carácter utilizado para aplicar secuencias de escape a valores entre comillas en los que el separador puede formar parte del valor.

null

Ejemplo de valor predeterminado: quote.value: "u0000" —> male,NULJohn,LastNameNUL

Ejemplo personalizado: quote.value: "\"" —> male,"John,LastName"

csvOptions.quoteAll.value

Opcional

Solo para"fileType.value": "csv". Indica si todos los valores deben ir siempre entre comillas. El valor predeterminado es aplicar secuencias de escape únicamente a los valores que contienen un carácter de comillas.

false

quoteAll:false —> male,John,"TestLastName"

quoteAll:true —>"male","John","TestLastName"

csvOptions.delimiter.value

Opcional

Solo para"fileType.value": "csv". Establece un separador para cada campo y valor. Este separador puede tener uno o más caracteres.

,

delimiter:, —> comma-separated values"

delimiter:\t —> tab-separated values

csvOptions.escape.value

Opcional

Solo para"fileType.value": "csv". Establece un solo carácter utilizado para las comillas de escape dentro de un valor ya citado.

\

"escape":"\\" —> male,John,"Test,\"LastName5"

"escape":"'" —> male,John,"Test,'''"LastName5"

csvOptions.escapeQuotes.value

Opcional

Solo para"fileType.value": "csv". Indica si los valores que contienen comillas siempre deben incluirse entre comillas. El valor predeterminado es omitir todos los valores que contengan un carácter de comillas.

true

csvOptions.header.value

Opcional

Solo para"fileType.value": "csv". Indica si se deben escribir los nombres de las columnas como primera línea en el archivo exportado.

true

csvOptions.ignoreLeadingWhiteSpace.value

Opcional

Solo para"fileType.value": "csv". Indica si se deben recortar los espacios en blanco iniciales de los valores.

true

ignoreLeadingWhiteSpace:true —> "male","John","TestLastName"

ignoreLeadingWhiteSpace:false—> " male","John","TestLastName"

csvOptions.ignoreTrailingWhiteSpace.value

Opcional

Solo para"fileType.value": "csv". Indica si se deben recortar los espacios en blanco finales de los valores.

true

ignoreTrailingWhiteSpace:true —> "male","John","TestLastName"

ignoreTrailingWhiteSpace:false—> "male ","John","TestLastName"

csvOptions.nullValue.value

Opcional

Solo para"fileType.value": "csv". Establece la representación de cadena de un valor nulo.

""

nullvalue:"" —> male,"",TestLastName

nullvalue:"NULL" —> male,NULL,TestLastName

csvOptions.dateFormat.value

Opcional

Solo para"fileType.value": "csv". Indica el formato de fecha.

yyyy-MM-dd

dateFormat:yyyy-MM-dd —> male,TestLastName,John,2022-02-24

dateFormat:MM/dd/yyyy —> male,TestLastName,John,02/24/2022

csvOptions.timestampFormat.value

Opcional

Solo para"fileType.value": "csv". Establece la cadena que indica un formato de marca de tiempo.

yyyy-MM-dd'T'HH:mm:ss[.SSS][XXX]

csvOptions.charToEscapeQuoteEscaping.value

Opcional

Solo para"fileType.value": "csv". Establece un solo carácter utilizado para omitir el escape del carácter de comillas.

\ cuando los caracteres de escape y comillas son diferentes. \0 cuando el carácter de escape y el carácter de comillas son iguales.

csvOptions.emptyValue.value

Opcional

Solo para"fileType.value": "csv". Establece la representación de cadena de un valor vacío.

""

"emptyValue":"" --> male,"",John

"emptyValue":"empty" --> male,empty,John

maxFileRowCount

Opcional

Indica el número máximo de filas por archivo exportado, entre 1 000 000 y 10 000 000 de filas.

5.000.000

includeFileManifest

Opcional

Habilita la compatibilidad para exportar un manifiesto de archivo junto con las exportaciones de archivo. El archivo JSON de manifiesto contiene información sobre la ubicación de exportación, el tamaño de exportación, etc. Se ha asignado un nombre al manifiesto con el formato manifest-<<destinationId>>-<<dataflowRunId>>.json.

Ver archivo de manifiesto de ejemplo. El archivo de manifiesto incluye los campos siguientes:

flowRunId: la ejecución de flujo de datos que generó el archivo exportado.
scheduledTime: la hora en UTC en que se exportó el archivo.
exportResults.sinkPath: ruta de acceso de la ubicación de almacenamiento en la que se deposita el archivo exportado.
exportResults.name: nombre del archivo exportado.
size: tamaño del archivo exportado, en bytes.

Pasos siguientes next-steps

Después de leer este artículo, debería comprender mejor cómo funciona el formato de archivos en una configuración de servidor de destino y cómo puede configurarlo.

Para obtener más información acerca de los demás componentes del servidor de destino, consulte los siguientes artículos:

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6