Identificar usuários

Use esse ponto de extremidade para identificar um usuário não identificado (somente alias).

A chamada para /users/identify combina o perfil somente de alias com o perfil identificado e remove o perfil somente de alias.

A identificação de um usuário requer que um external_id seja incluído no objeto aliases_to_identify. Se não houver nenhum usuário com esse external_id, o external_id será adicionado ao registro do usuário com alias, e o usuário será considerado identificado. É possível adicionar até 50 aliases de usuário por solicitação.

Posteriormente, é possível associar vários aliases de usuário adicionais a um único external_id.

• Quando essas associações subsequentes são feitas com o campo merge_behavior definido como none, somente os tokens por push e o histórico de mensagens associados ao alias do usuário são mantidos; quaisquer atributos, eventos ou compras ficarão “órfãos” e não estarão disponíveis para o usuário identificado. Uma solução alternativa é exportar os dados do usuário com aliasing de usuário antes da identificação usando o ponto de extremidade/users/export/ids e, em seguida, associar novamente os atributos, eventos e compras ao usuário identificado.
• Quando as associações são feitas com o campo merge_behavior definido como merge, esse ponto de extremidade mesclará campos específicos encontrados no usuário anônimo com o usuário identificado.

Pré-requisitos

Para usar esse endpoint, você precisará de uma chave de API com a permissão users.identify.

Limite de taxa

Um limite de frequência é aplicado a solicitações feitas a esse endpoint para clientes que fizeram a integração com o Braze em 16 de setembro de 2021 ou após essa data. Para saber mais, consulte Limites da API.

Corpo da solicitação

1
2
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY

1
2
3
4
{
   "aliases_to_identify" : (required, array of alias to identify objects), 
   "merge_behavior": (optional, string) one of 'none' or 'merge' is expected
}

Parâmetros de solicitação

Campo Merge_behavior

Definir o campo merge_behavior como merge define o ponto de extremidade para mesclar qualquer um dos seguintes campos encontrados exclusivamente no usuário anônimo para o usuário identificado.

• Nome
• Sobrenome
• E-mail
• Gênero
• Data de nascimento
• Número de telefone
• Fuso horário
• Cidade natal
• País
• Idioma
• Contagem de sessões (a soma das sessões de ambos os perfis)
• Data da primeira sessão (o Braze escolherá a data mais cedo entre as duas datas)
• Data da última sessão (o Braze escolherá a data mais recente entre as duas datas)
• Atributos personalizados
• Dados de eventos personalizados e de eventos de compra
• Propriedades de eventos personalizados e de eventos de compra para a segmentação “X vezes em Y dias” (onde X<=50 e Y<=30)
• Resumo dos eventos personalizados segmentáveis
  • Contagem de eventos (a soma de ambos os perfis)
  • O evento ocorreu pela primeira vez (o Braze escolherá a data mais antiga entre as duas datas)
  • Evento ocorrido pela última vez (o Braze escolherá a data mais recente entre as duas datas)
• Total de compras no app em centavos (a soma de ambos os perfis)
• Número total de compras (a soma de ambos os perfis)
• Data da primeira compra (o Braze escolherá a data mais antiga entre as duas datas)
• Data da última compra (o Braze escolherá a data mais recente entre as duas datas)
• Resumos do app
• Campos Last_X_at (o Braze atualizará os campos se os campos do perfil órfão forem mais recentes)
• Resumos de campanha (o Braze escolherá os campos de data mais recentes)
• Resumos do fluxo de trabalho (o Braze escolherá os campos de data mais recentes)
• Histórico de mensagens e de engajamento com mensagens

Qualquer um dos seguintes campos encontrados no usuário anônimo para o usuário identificado:

• Contagem de eventos personalizados e eventos de compra e registros de data e hora da primeira e da última data
  • Esses campos mesclados atualizarão os filtros “para X eventos em Y dias”. Para eventos de compra, esses filtros incluem “número de compras em Y dias” e “dinheiro gasto nos últimos Y dias”.

Os dados de sessão só serão mesclados se o app existir em ambos os perfis de usuário. Por exemplo, se o usuário-alvo não tiver um resumo do aplicativo “ABCApp”, mas o usuário original tiver, o usuário-alvo terá o resumo do aplicativo “ABCApp” em seu perfil após a mesclagem.

Definir o campo como none não mesclará nenhum dado de usuário ao perfil de usuário identificado.

Identificação de usuários por e-mail

Se um email for especificado como um identificador, um valor prioritization adicional será necessário no identificador. O prioritization deve ser uma matriz que especifica qual usuário deve ser mesclado se houver vários usuários encontrados. prioritization é uma matriz ordenada, ou seja, se mais de um usuário corresponder a uma priorização, a mesclagem não ocorrerá.

Os valores permitidos para o vetor são: identified, unidentified, most_recently_updated. most_recently_updated refere-se à priorização do usuário atualizado mais recentemente.

Somente uma das opções a seguir pode existir na matriz de priorização por vez:

• identified refere-se à priorização de um usuário com uma external_id
• unidentified refere-se à priorização de um usuário sem um external_id

Exemplo de solicitação

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
curl --location --request POST 'https://rest.iad-01.braze.com/users/identify' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--data-raw '{
  "aliases_to_identify": [
    {
      "external_id": "external_identifier",
      "user_alias": {
          "alias_name": "example_alias",
          "alias_label": "example_label"
      }
    }
  ],
  "emails_to_identify": [
    {
      "external_id": "external_identifier_2",
      "email": "john.smith@braze.com",
      "prioritization": ["unidentified", "most_recently_updated"]
    }
  ]
  "merge_behavior": "merge"
}'

Resposta

1
2
3
4
5
6
Content-Type: application/json
Authorization: Bearer YOUR_REST_API_KEY
{
    "aliases_processed": 1,
    "message": "success"
}