4. Formato de archivos

bruno.morini@retargetly.com Updated by bruno.morini@retargetly.com

Los archivos necesitan tener un formato estándar para que el sistema pueda leerlos correctamente.

Nombre y extensión

Los archivos se podrán ubicar en el directorio raíz del repositorio o en cualquier nivel de subdirectorios ubicado en el mismo.

Consideraciones:

  • Podrán contener cualquier nombre, sin espacios y con extensión .tsv
  • Podrán estar comprimidos en formato GZIP.
  • Los archivos deben ser TSV válidos.

Formato de archivo

El formato por defecto aceptado para el procesamiento de la data es TSV en el cuál en la primera fila del mismo debe especificarse las cabeceras indicando qué tipo de valor se encuentra en cada columna. Las cabeceras aceptadas son las siguientes:

  • device_type (obligatorio): Tipo de dispositivo de usuario. Ejemplo: android, ios, web, etc...
  • device_id (obligatorio): Identificador del dispositivo de usuario. Ejemplo: 00461ac5-f632-4e2e-8ae8-e7429eba81a4
  • country: Identificador del País (AR, CL, CO, BR, PE, EC, UY, MX)
  • segments (obligatorio): Lista de IDs de segmentos separados por coma para asignar al usuario.
  • country_code (opcional): Código de país. Indica de qué país es el usuario.
  • partner_segment_id (opcional): ID propio asociado a un segmento. Puede utilizarse como identificador interno o bien para el mapping y populación de segmentos vía Data-IN tomando como referencia este ID.
  • remove_segments (opcional): Remover devices que han sido asociados (populado) un segmento
  • remove_partner_segment_id (opcional): Mismo caso que el anterior pero utilizanco como guía este ID y no el de Segmento.

Los valores posibles de tipo de dispositivo (columna device_type) son los siguientes:

  • web: el device_id es un dispositivo web de retargetly (retargetly id de la web cookie)
  • android: el device_id corresponde a un id de dispositivo android - ADID.
  • ios: el device_id corresponde a un id de dispositivo ios - IDFA.
  • external_id: el device_id es un identificador externo asociado por el partner a la web cookie. Para asociar ids externos, ver el siguiente artículo: 1. Proceso de Sync de cookies de usuario)
  • email: el device_id corresponde a un usuario identificado por su email
  • phone: el device_id corresponde a un usuario identificado por su número de teléfono
  • nid: (el device_id corresponde a un identificador nacional, es decir, un número de documento: DNI, CI, etc...).
  • rely_encrypt: el device_id se encuentra encriptado. Para poder usar este campo es necesario generar una clave de encriptación previamente desde Retargetly. Es necesario avisar anteriormente al equipo de desk@retargetly.com cuando se quiera usar este tipo de device_type. El device_id se deberá encriptar previamente antes de ingestar.

Consideraciones:

  • Entre los distintos campos subidos (tipo de dispositivo, el ID usuario, segmentos, etc...) hay un caracter TAB, también referenciado como \t. En cambio, los ids de los segmentos deben estar separados por el caracter "," (coma). Además al final de cada línea está el caracter de fin de línea, también referenciado como enter o \n. No es válido el caracter retorno de carro, también referenciado como \r.
  • Los tipos de dispositivo: email, phone y nid, admiten subirse en texto plano o hasheados en formato sha256 o sha512. En el caso de que se envíen en texto plano, serán hasheados automáticamente a sha256 para su almacenamiento. Previo al hasheo, deberán respetar el siguiente formato:
    • email: deben ir todo en minúscula. Ejemplo: ejemplo@gmail.com
    • nid: solo incluir números. Ningún otro caracter es válido. Ejemplo: 34848988
    • phone: solo números y en el formato (código de país)(código de área sin 0)(número). Ejemplo: 541151190123

Ejemplo válido de archivo:

device_type    device_id    country_code    segments
email    ejemplo@gmail.com    MX    111111,22222,33333
email    fc2ae4a1fb374548ea80556dc51ab3471a311231d8bffaa1dece31371bcceb62    AR    123456,123410,232322
android    1b671a64-40d5-491e-99b0-da01ff1f3341    AR    123123

Ejemplo inválido de archivo:

  • Falta cabecera
email    ejemplo@gmail.com    111111,22222,33333
android    1b671a64-40d5-491e-99b0-da01ff1f3341    123123

  • Tipo de dispositivo inválido
device_type    device_id    segments
android    1b671a64-40d5-491e-99b0-da01ff1f3341    123123
e-mail    ejemplo@gmail.com    111111,22222,33333

  • El caracter que divide los campos no es TAB
device_type;device_id;country_code;segments
email;ejemplo@gmail.com;MX;111111,22222,33333
email;fc2ae4a1fb374548ea80556dc51ab3471a311231d8bffaa1dece31371bcceb62    AR    123456,123410,232322
android;1b671a64-40d5-491e-99b0-da01ff1f3341;AR;123123

  • Faltan los segmentos a asignar al usuario y el tipo de dispositivo.
device_id
ejemplo@gmail.com
fc2ae4a1fb374548ea80556dc51ab3471a311231d8bffaa1dece31371bcceb62
1b671a64-40d5-491e-99b0-da01ff1f3341

How did we do?

3. Ingesta de archivos de data

Formato para tool de enrichment

Contact