Atributos padrão
Atributos padrão são campos predefinidos que a Braze reconhece em todos os perfis de usuário. Use esta página como referência rápida para o nome do campo, o tipo de dados e o formato esperado de cada atributo padrão.
Atributos padrão (às vezes chamados de atributos default ou chaves reservadas) são diferentes dos atributos personalizados, que são exclusivos do seu negócio. Quando você envia dados para a Braze com um dos nomes de campo listados nesta página, a Braze armazena o valor no campo de perfil predefinido em vez de criar um novo atributo personalizado.
Você pode definir atributos padrão por qualquer um destes métodos:
- O SDK da Braze
- O objeto de atributos de usuário no endpoint
/users/track - Importação de CSV
- Ingestão de dados na nuvem

Os nomes dos atributos padrão diferenciam maiúsculas de minúsculas. Sempre use letras minúsculas (por exemplo, first_name, não First_Name). Se a grafia ou capitalização não corresponder exatamente, a Braze armazena o valor como um atributo personalizado.
Identificadores
Os identificadores informam à Braze qual perfil de usuário atualizar ou criar. Toda requisição de API e linha de CSV deve incluir pelo menos um identificador. Para saber como escolher o mais adequado, consulte Resolução de identificadores.
| Campo | Tipo de dados | Formato e observações |
|---|---|---|
external_id |
String | Um identificador de usuário exclusivo que você atribui. Depois de definido em um perfil, a Braze o utiliza para reconhecer o usuário em diferentes dispositivos. Não pode ser removido após ser adicionado. |
braze_id |
String | Um identificador atribuído pela Braze, criado quando o SDK detecta um dispositivo pela primeira vez. Somente leitura. Não pode ser editado. |
user_alias |
Objeto | Um objeto contendo alias_name (string) e alias_label (string), usado para identificar usuários sem um external_id. Mutuamente exclusivo com external_id na mesma requisição. |
email |
String | Pode ser usado como identificador quando external_id e user_alias estão ausentes. Tem precedência sobre phone se ambos forem enviados. |
phone |
String | Pode ser usado como identificador quando external_id, user_alias e email estão ausentes. Use o formato E.164 (por exemplo, +14155552671). |
Campos de perfil
Esses campos capturam dados demográficos, de contato e de localidade dos seus usuários.
| Campo | Tipo de dados | Formato e observações |
|---|---|---|
first_name |
String | O nome do usuário (por exemplo, Jane). |
last_name |
String | O sobrenome do usuário (por exemplo, Doe). |
email |
String | O endereço de e-mail do usuário (por exemplo, [email protected]). |
phone |
String | O número de telefone do usuário. Use o formato E.164 (por exemplo, +14155552671). |
dob |
String | Data de nascimento no formato YYYY-MM-DD (por exemplo, 1988-02-14). Permite direcionamento por aniversário. |
gender |
String | Um dos valores: M, F, O (outro), N (não aplicável), P (prefere não dizer) ou null (desconhecido). |
country |
String | Um código de país no formato ISO 3166-1 alpha-2 (por exemplo, US, GB). Definir country por importação de CSV ou API impede que o SDK o capture automaticamente. |
home_city |
String | A cidade do usuário (por exemplo, London). |
language |
String | Um código de idioma no formato ISO 639-1 (por exemplo, en). Consulte a lista de idiomas aceitos. Definir language por importação de CSV ou API impede que o SDK o capture automaticamente. |
time_zone |
String | Um nome de fuso horário do banco de dados de fusos horários da IANA (por exemplo, America/New_York ou Eastern Time (US & Canada)). |
current_location |
Objeto | Um objeto contendo longitude e latitude (por exemplo, {"longitude": -73.991443, "latitude": 40.753824}). |
image_url |
String | Uma URL para a imagem de perfil do usuário. Até 1.024 caracteres. |
Inscrição e consentimento
Esses campos gerenciam como um usuário recebe mensagens em diferentes canais. Atualizá-los não conta para o consumo de pontos de dados.
| Campo | Tipo de dados | Formato e observações |
|---|---|---|
email_subscribe |
String | Um dos valores: opted_in (registrou-se explicitamente para receber e-mail), unsubscribed (cancelou explicitamente a inscrição de e-mail) ou subscribed (nem optou por receber nem cancelou). |
push_subscribe |
String | Um dos valores: opted_in, unsubscribed ou subscribed. Mesmas definições de email_subscribe. |
subscription_groups |
Array de objetos | Um array em que cada objeto possui um subscription_group_id (string) e um subscription_state (subscribed ou unsubscribed). Por exemplo: [{"subscription_group_id": "abc-123", "subscription_state": "subscribed"}]. |
email_open_tracking_disabled |
Booleano | true ou false. Defina como true para desativar o pixel de rastreamento de abertura de e-mail para este usuário. Disponível apenas para SparkPost e SendGrid. |
email_click_tracking_disabled |
Booleano | true ou false. Defina como true para desativar o rastreamento de cliques em e-mail para este usuário. Disponível apenas para SparkPost e SendGrid. |
marked_email_as_spam_at |
String | Timestamp em que o e-mail do usuário foi marcado como spam. Use o formato ISO 8601. |
Para saber mais sobre a configuração de grupos de inscrições, consulte Grupos de inscrições.
Sessões e engajamento
Esses campos registram quando o usuário interagiu com o seu app pela primeira ou última vez. O SDK os registra automaticamente; normalmente, você os define pela API ou CSV apenas ao migrar de outra plataforma.
| Campo | Tipo de dados | Formato e observações |
|---|---|---|
date_of_first_session |
String | A data em que o usuário usou o app pela primeira vez. Use o formato ISO 8601 ou um dos seguintes: yyyy-MM-ddTHH:mm:ss:SSSZ, yyyy-MM-ddTHH:mm:ss, yyyy-MM-dd HH:mm:ss, yyyy-MM-dd, MM/dd/yyyy ou ddd MM dd HH:mm:ss.TZD YYYY. |
date_of_last_session |
String | A data em que o usuário usou o app pela última vez. Mesmos formatos aceitos de date_of_first_session. |
Tokens por push
Use esses campos ao migrar tokens por push de outra plataforma. Após integrar o SDK da Braze, os tokens por push são capturados automaticamente. Para orientações sobre migração, consulte Migração de tokens por push.
| Campo | Tipo de dados | Formato e observações |
|---|---|---|
push_tokens |
Array de objetos | Um array em que cada objeto possui um app_id (string) e um token (string). Opcionalmente, inclua um device_id (string). Por exemplo: [{"app_id": "YOUR_APP_ID", "token": "abcd", "device_id": "optional_device_id"}]. |
push_token_import |
Booleano | Flag de nível superior (não aninhada em attributes). Defina como true para importar tokens por push legados de usuários anônimos sem um external_id. |
Perfil social
Esses campos armazenam dados de integrações com redes sociais.
| Campo | Tipo de dados | Formato e observações |
|---|---|---|
facebook |
Objeto | Um objeto contendo qualquer combinação de id (string), likes (array de strings) ou num_friends (inteiro). |
twitter |
Objeto | Um objeto contendo qualquer combinação de id (inteiro), screen_name (string, identificador do X), followers_count (inteiro), friends_count (inteiro) ou statuses_count (inteiro). |
Exemplo de API
A requisição a seguir define atributos padrão em dois usuários por meio do endpoint /users/track.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
POST https://YOUR_REST_API_URL/users/track
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
"attributes": [
{
"external_id": "user1",
"first_name": "Jane",
"last_name": "Doe",
"email": "[email protected]",
"country": "US",
"language": "en",
"time_zone": "America/New_York",
"dob": "1988-02-14",
"email_subscribe": "opted_in"
},
{
"external_id": "user2",
"first_name": "Alex",
"phone": "+14155552671",
"current_location": {
"longitude": -73.991443,
"latitude": 40.753824
},
"subscription_groups": [
{
"subscription_group_id": "abc-123",
"subscription_state": "subscribed"
}
]
}
]
}
Para o contrato completo da API, consulte o Objeto de atributos de usuário.
Exemplo de CSV
O CSV a seguir atualiza atributos padrão de dois usuários. Os cabeçalhos das colunas devem corresponder exatamente aos nomes dos campos neste artigo. Cabeçalhos que não correspondem (por exemplo, First_name em vez de first_name) são importados como atributos personalizados.
1
2
3
external_id,first_name,last_name,email,country,language,dob,email_subscribe
user1,Jane,Doe,[email protected],US,en,1988-02-14,opted_in
user2,Alex,Smith,[email protected],GB,en,1992-09-30,subscribed
Alguns atributos padrão não podem ser definidos por importação de CSV. Arrays, tokens por push e objetos aninhados devem ser enviados pela API ou pela Ingestão de dados na nuvem. Para a lista completa de campos compatíveis com CSV e as etapas de importação, consulte Atributos padrão.
Considerações
Leve em conta os seguintes pontos ao trabalhar com atributos padrão:
- Os nomes dos campos diferenciam maiúsculas de minúsculas. Sempre use letras minúsculas. Um cabeçalho ou chave que não corresponda exatamente ao nome de um atributo padrão é tratado como atributo personalizado.
- A captura automática do SDK é desativada quando você define valores pela API ou CSV. Quando você define
countryoulanguagepela API ou CSV, a Braze para de capturar automaticamente esses campos pelo SDK para aquele usuário. nullremove um valor. Defina um atributo padrão comonullpara removê-lo do perfil. Alguns campos, incluindoexternal_ideuser_alias, não podem ser removidos após serem definidos.- Valores em branco no CSV não sobrescrevem. Uma célula vazia em uma importação de CSV mantém o valor existente no perfil. Para limpar um valor, use a API.
- O fuso horário padrão é UTC. Strings de data sem deslocamento são interpretadas como meia-noite UTC e exibidas no fuso horário do seu espaço de trabalho. Para especificar um fuso horário, adicione um deslocamento UTC (por exemplo,
2024-11-10T18:00:00-05:00).
Páginas relacionadas
- Objeto de atributos de usuário — Contrato completo da API para o objeto de atributos.
- Endpoint
/users/track— Endpoint REST para criar e atualizar perfis de usuário. - Definir atributos de usuário — Métodos do SDK para definir atributos padrão e personalizados.
- Importação de CSV — Faça upload de atributos padrão por meio de um arquivo CSV.
- Atributos personalizados — Defina atributos exclusivos do seu negócio.
- Tipos de dados — Referência dos tipos de dados compatíveis.