Identifier les utilisateurs

Utilisez cet endpoint pour identifier un utilisateur non identifié (alias uniquement ou e-mail uniquement) à l’aide de l’ID externe fourni.

Fonctionnement

L’appel à /users/identify combine un profil utilisateur identifié par un alias (profil alias seul) ou une adresse e-mail (profil e-mail seul) avec un profil utilisateur possédant un external_id (profil identifié), puis supprime le profil alias seul.

L’identification d’un utilisateur nécessite qu’un external_id soit inclus dans l’objet aliases_to_identify ou emails_to_identify. S’il n’existe pas d’utilisateur possédant cette adresse external_id, l’adresse external_id sera ajoutée à l’enregistrement de l’utilisateur aliasé et l’utilisateur sera considéré comme identifié.

Notez ce qui suit :

• Lorsque ces associations ultérieures sont effectuées avec le champ merge_behavior défini sur none, seuls les jetons de notification push et l’historique des messages associés à l’alias d’utilisateur sont conservés. Tous les attributs, événements ou achats deviendront « orphelins » et non disponibles pour l’utilisateur identifié. Une solution consiste à exporter les données de l’utilisateur aliasé avant l’identification à l’aide de l’ endpoint/users/export/ids , puis à réassocier les attributs, les événements et les achats à l’utilisateur identifié.
• Lorsque des associations sont faites avec le champ merge_behavior défini sur merge, cet endpoint fusionnera les champs spécifiques trouvés sur l’utilisateur anonyme avec ceux de l’utilisateur identifié.

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation users.identify.

Limite de débit

For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 20,000 requests per minute to this endpoint. This rate limit is shared with the /users/delete, /users/alias/new, /users/merge, and /users/alias/update endpoints, as documented in API rate limits.

Corps de la demande

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

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

Paramètres de demande

Vous pouvez ajouter jusqu’à 50 alias utilisateur par demande. Vous pouvez associer plusieurs alias utilisateur supplémentaires à un seul external_id.

Champ Merge_behavior

En attribuant la valeur merge au champ merge_behavior, l’endpoint fusionne avec l’utilisateur anonyme la liste suivante de champs trouvés exclusivement sur l’utilisateur identifié. Configurer le champ sur none ne fusionnera aucune donnée utilisateur avec le profil utilisateur identifié.

Identifier les utilisateurs par e-mail

Si un email est spécifié comme identifiant, une valeur prioritization supplémentaire est requise dans l’identifiant. prioritization doit être un tableau spécifiant l’utilisateur à fusionner s’il y a plusieurs utilisateurs trouvés. prioritization est un tableau ordonné, ce qui signifie que si plus d’un utilisateur correspond à un ordre de priorité, la fusion n’aura pas lieu.

Les valeurs autorisées pour le tableau sont les suivantes : identified, unidentified, most_recently_updated. most_recently_updated signifie que la priorité est accordée à l’utilisateur ayant effectué la dernière mise à jour.

Une seule des options suivantes peut exister à la fois dans le tableau de priorisation :

• identified Il s’agit de donner la priorité à un utilisateur ayant une external_id
• unidentified Il s’agit de donner la priorité à un utilisateur qui n’a pas de external_id

Exemple de demande

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"
}'

Réponse

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