4. Formato de arquivos

Os arquivos precisam ter um formato padronizado para que os sistemas possam interpretá-los corretamente. 

Nome e extensão

Os arquivos podem ser localizados no diretório raiz ou em qualquer nível de subdiretórios localizados do repositório. 

Considerações:

 - Poderão ter qualquer nome, sem espaços e com extensão .tsv ou .tsv.gz.

 - Poderão estar comprimidos em formato GZIP.

 - Os arquivos devem ter o formato TSV válido, ou seja, arquivos com campos separados por Tabs. 

Formato de arquivo

O formato TSV é aceito por padrão para o processamento dos dados, sendo que na primeira linha devem estar especificados os cabeçalhos indicando que tipo de valor pode se encontrado em cada coluna. Os cabeçalhos aceitos são: 

• device_type (obrigatório): tipo de dispositivo do usuário. Exemplo: android,ios,web,etc...
• device_id (obrigatório): identificador do dispositivo do usuário. Exemplo: 00461ac5-f632-4e2e-8ae8-e7429eba81a4.
• segments (obrigatório): lista de IDs de segmentos separados por vírgula para que seja possível associar o registro ao usuário. 
• Código do país (opcional): código do país. Indica de que país é o usuário. 

Os valores possíveis para o tipo de dispositivo (coluna device_type) são: 

• web: o device_id é um dispositivo web da Retargelty (retargetly id do cookie web)
• android: o device_id corresponde a um id do dispositivo - ADID.
• ios: o device_id corresponde a um id do dispositivo ios - IDFA.
• external_id: o device_id é um identificador externo associado pelo partner ao web cookie. Para associar ids externos, leia atentamente o seguinte manual:

https://desk.retargetly.com/l/es/l/es/article/5vl6dy0hf3-user-cookie-sync-process

• email: o device_id corresponde a um usuário identificado pelo seu e-mail. 
• phone: o device_id corresponde a um usuário identificado pelo número de seu telefone.
• nid: (o device_id corresponde a um identificador nacional, ou seja, um número de documento: RG, etc...).
• rely_encrypt: o device_id está criptografado. Para que este campo possa ser utilizado é necessário gerar uma chave de descriptografia no sistema da Retargetly. É necessário avisar anteriormente a equipe da Retargetly, enviando um e-mail a desk@retargetly. O device_id deverá ser criptografado antes de ser incluído para processamento.

Considerações: 

•  Entre os diferentes campos enviados (tipo de dispositivo, o ID dos usuários, segmentos, etc.) existe um caractere TAB que também é referenciado como \t. Já os ids dos segmentos devem estar separados pelo caractere “,” (vírgula). No final de cada linha está o caractere do fim da linha, também referenciado como enter ou \n. Não é válido o caractere retorno de carro, também diferenciado como \r.
•  Os tipos de dispositivos: e-mail, phone e nid, podem estar em texto puro ou no formato de hashing sha256 ou sha512. Se for enviado em texto puro, serão transformados imediatamente em sha256 para o seu armazenamento. Antes da transformação, deverá ser respeitado o seguinte formato: 
• e-mail: devem ir com letras minúsculas. Exemplo: exemplo@gmail.com
• nid: somente com números. Não serão aceitos outros caracteres.  Exemplo: 34848988
• phone: somente os números e em formato (código do país)(código de área sem o o zero a esquerda)(número). Exemplo: 54115119012

Exemplo válido de arquivo:

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

Exemplo inválido de arquivo:

Falta cabeçalho:

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

O caractere que divide os campos não é o 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

Faltam os segmentos para serem associados ao usuário e o tipo de dispositivo:

device_id
ejemplo@gmail.com
fc2ae4a1fb374548ea80556dc51ab3471a311231d8bffaa1dece31371bcceb62
1b671a64-40d5-491e-99b0-da01ff1f3341