Skip to content

Objet Attributs d’utilisateur

Une demande d’API comportant un champ quelconque dans l’objet attributs crée ou met à jour un attribut de ce nom avec la valeur donnée sur le profil utilisateur spécifié.

Utilisez les noms de champs de profil utilisateur Braze (énumérés comme suit ou tout autre répertorié dans la section pour Braze user profile fields) pour mettre à jour ces valeurs spéciales sur le profil utilisateur dans le tableau de bord ou ajoutez vos propres données d’attributs personnalisés à l’utilisateur.

Corps de l’objet

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{
  // One of "external_id" or "user_alias" or "braze_id" or "email" or "phone" is required
  "external_id" : (optional, string) see external user ID,
  "user_alias" : (optional, User alias object),
  "braze_id" : (optional, string) Braze user identifier,
  "email": (optional, string) User email address,
  "phone": (optional, string) User phone number,
  // Setting this flag to true puts the API in "Update Only" mode.
  // When using a "user_alias", "Update Only" defaults to true.
  "_update_existing_only" : (optional, boolean),
  // See note regarding anonymous push token imports
  "push_token_import" : (optional, boolean),
  // Braze User Profile Fields
  "first_name" : "Jon",
  "email" : "[email protected]",
  // Custom Attributes
  "my_custom_attribute" : value,
  "my_custom_attribute_2" : {"inc" : int_value},
  "my_array_custom_attribute":[ "Value1", "Value2" ],
  // Adding a new value to an array custom attribute
  "my_array_custom_attribute" : { "add" : ["Value3"] },
  // Removing a value from an array custom attribute
  "my_array_custom_attribute" : { "remove" : [ "Value1" ]},
}

Pour supprimer un attribut de profil, définissez-le sur null. Certains champs, tels que external_id et user_alias, ne peuvent pas être supprimés après avoir été ajoutés à un profil utilisateur.

Mettre à jour les profils existants uniquement

Si vous souhaitez mettre à jour uniquement les profils utilisateur existants dans Braze, vous devez passer la clé _update_existing_only avec la valeur true dans le corps de votre demande. Si cette valeur est omise, Braze crée un nouveau profil utilisateur si le site external_id n’existe pas encore.

Importation de jetons de notification push

Avant d’importer des jetons de notification push à Braze, vérifiez si cela est nécessaire. Lorsque les SDK de Braze sont mis en place, ils gèrent automatiquement les jetons de poussée sans qu’il soit nécessaire de les télécharger via l’API.

Si vous devez les télécharger via l’API, vous pouvez le faire pour des utilisateurs identifiés ou anonymes. Cela signifie que soit un external_id doit être présent, soit les utilisateurs anonymes doivent avoir l’indicateur push_token_import défini sur true.

Lorsque vous indiquez push_token_import comme true :

  • external_id et braze_id ne doivent pas être spécifiés
  • L’objet d’attribut doit contenir un jeton de poussée.
  • Si le jeton existe déjà dans Braze, la demande est ignorée ; dans le cas contraire, Braze crée un profil utilisateur anonyme temporaire pour chaque jeton afin de vous permettre de continuer à envoyer des messages à ces personnes

Après l’importation, lorsque chaque utilisateur lance la version de votre application compatible avec Braze, Braze déplace automatiquement son jeton push importé vers son profil utilisateur Braze et nettoie le profil temporaire.

Braze vérifie une fois par mois s’il existe un profil anonyme avec le drapeau push_token_import qui n’a pas de jeton de poussée. Si le profil anonyme n’a plus de jeton de poussée, Braze supprime le profil. Cependant, si le profil anonyme dispose toujours d’un jeton de poussée, ce qui suggère que l’utilisateur réel doit encore s’identifier sur l’appareil avec ledit jeton de poussée, Braze ne fait rien.

Pour plus d’informations, consultez Migration des jetons Push.

Types de données des attributs personnalisés

Les types de données suivants peuvent être stockés en tant qu’attribut personnalisé :

Exemple de tableau d’objets

Ce tableau d’objets vous permet de créer des segments basés sur des critères spécifiques au sein des séjours, et de personnaliser vos messages en utilisant les données de chaque séjour avec les modèles Liquid.

1
2
3
4

"hotel_stays": [
  { "hotel_name": "Ocean View Resort", "check_in_date": "2023-06-15", "nights_stayed": 5 },
  { "hotel_name": "Mountain Lodge", "check_in_date": "2023-09-10", "nights_stayed": 3 }
  ]

Champs Braze User Profile (Profil d’utilisateur Braze)

Les valeurs linguistiques définies explicitement par l’intermédiaire de cette API sont prioritaires sur les informations relatives aux paramètres linguistiques que Braze reçoit automatiquement de l’appareil.

Demande d’exemple d’attribut utilisateur

Cet exemple contient quatre objets d’attributs d’utilisateur, sur un total de 75 objets d’attributs autorisés par appel API.

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

POST https://YOUR_REST_API_URL/users/track
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "attributes" : [
    {
      "external_id" : "user1",
      "first_name" : "Jon",
      "has_profile_picture" : true,
      "dob": "1988-02-14",
      "music_videos_favorited" : { "add" : [ "calvinharris-summer" ], "remove" : ["nickiminaj-anaconda"] }
    },
    {
      "external_id" : "user2",
      "first_name" : "Jill",
      "has_profile_picture" : false,
      "push_tokens": [{"app_id": "Your App Identifier", "token": "abcd", "device_id": "optional_field_value"}]

    },
    {
      "user_alias" : { "alias_name" : "device123", "alias_label" : "my_device_identifier"},
      "first_name" : "Alice",
      "has_profile_picture" : false
    },
    {
      "external_id": "user3",
      "subscription_groups" : [{"subscription_group_id" : "subscription_group_identifier", "subscription_state" : "subscribed"}]
    }
  ]
}

Migration des jetons Push

Si vous envoyiez des notifications push avant d’intégrer Braze, soit par vous-même, soit par un autre fournisseur, la migration des jetons push vous permet de continuer à envoyer des notifications push à vos utilisateurs avec des jetons push enregistrés.

Migration automatique grâce au SDK

Après avoir intégré le SDK de Braze, les jetons de push de vos utilisateurs abonnés sont automatiquement migrés la prochaine fois qu’ils ouvrent votre appli. En attendant, vous ne pouvez pas envoyer à ces utilisateurs des notifications push via Braze.

Vous pouvez également migrer vos jetons push manuellement, ce qui vous permettra de réengager vos utilisateurs plus rapidement.

Considérations relatives aux jetons Web

En raison de la nature des jetons de push pour le web, veillez à prendre en compte les éléments suivants lors de la mise en œuvre du push pour le web :

Migration manuelle via l’API

La migration manuelle des jetons push est le processus d’importation de ces clés précédemment créées dans votre plateforme Braze via l’API.

Migrez par programme les jetons iOS (APNs) et Android (FCM) vers votre plateforme en utilisant le users/track point de terminaison. Vous pouvez migrer à la fois les utilisateurs identifiés (utilisateurs avec un ID externe associé) et les utilisateurs anonymes (utilisateurs sans ID externe).

Spécifiez votre app_id lors de la migration du jeton de notification pour associer le jeton de notification approprié à l’application appropriée. Chaque application (iOS, Android, etc.) a son propre app_id, qui peut être trouvé dans la section Identification de la page Clés API. Assurez-vous d’utiliser les bonnes app_id pour chaque plateforme.

Pour les utilisateurs identifiés, définissez l’indicateur push_token_import sur false (ou omettez le paramètre) et spécifiez les valeurs external_id, app_id et token dans l’objet attributes utilisateur.

Par exemple :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

curl --location --request POST 'https://rest.iad-01.braze.com/users/track' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
--data-raw '{
  "attributes" : [
    {
      "push_token_import" : false,
      "external_id": "example_external_id",
      "country": "US",
      "language": "en",
      "YOUR_CUSTOM_ATTRIBUTE": "YOUR_VALUE",
      "push_tokens": [
        {"app_id": "APP_ID_OF_OS", "token": "PUSH_TOKEN_STRING"}
      ]
    }
  ]
}'

Lors de l’importation de jetons de notification push provenant d’autres systèmes, un external_id n’est pas toujours disponible. Dans ce cas, définissez votre indicateur push_token_import sur true et spécifiez les valeurs app_id et token. Braze crée un profil utilisateur anonyme temporaire pour chaque jeton afin de vous permettre de continuer à envoyer des messages à ces personnes. Si le jeton existe déjà dans Braze, la demande sera ignorée.

Par exemple :

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

curl --location --request POST 'https://rest.iad-01.braze.com/users/track' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-API-KEY-HERE' \
--data-raw '{
  "attributes": [
    {
      "push_token_import" : true,
      "email": "[email protected]",
      "country": "US",
      "language": "en",
      "YOUR_CUSTOM_ATTRIBUTE": "YOUR_VALUE",
      "push_tokens": [
        {"app_id": "APP_ID_OF_OS", "token": "PUSH_TOKEN_STRING", "device_id": "DEVICE_ID"}
      ]
    },

    {
      "push_token_import" : true,
      "email": "[email protected]",
      "country": "US",
      "language": "en",
      "YOUR_CUSTOM_ATTRIBUTE_1": "YOUR_VALUE",
      "YOUR_CUSTOM_ATTRIBUTE_2": "YOUR_VALUE",
      "push_tokens": [
        {"app_id": "APP_ID_OF_OS", "token": "PUSH_TOKEN_STRING", "device_id": "DEVICE_ID"}
      ]
    }
  ]
}'

Après l’importation, lorsque l’utilisateur anonyme lance la version de votre app compatible avec Braze, Braze déplace automatiquement son jeton push importé vers son profil utilisateur Braze et nettoie le profil temporaire.

Braze vérifie une fois par mois s’il existe un profil anonyme avec le drapeau push_token_import qui n’a pas de jeton de poussée. Si le profil anonyme n’a plus de jeton de poussée, Braze supprime le profil. Cependant, si le profil anonyme dispose toujours d’un jeton de poussée, ce qui suggère que l’utilisateur réel ne s’est pas encore connecté à l’appareil avec ledit jeton de poussée, Braze ne fait rien.

Importation de jetons push Android

Si vous devez envoyer une notification push Android à vos utilisateurs avant d’avoir terminé l’intégration du SDK Braze, utilisez des paires clé-valeur pour valider les notifications push.

Vous devez disposer d’un récepteur pour manipuler et afficher les charges utiles de push. Pour notifier le récepteur de la charge utile de push, ajoutez les paires valeur-clé nécessaires à la campagne push. Les valeurs de ces paires dépendent du partenaire push spécifique que vous utilisiez avant Braze.
Github   Modifier cette page sur GitHub
New Stuff!