Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devez intégrer le SDK de Braze.
Attributs par défaut de l’utilisateur
Méthodes prédéfinies
Braze fournit des méthodes prédéfinies pour définir les attributs utilisateur suivants dans la classe User :
- Prénom
- Nom
- Langue
- Pays
- Date de naissance
- E-mail
- Genre
- Ville d’origine
- Numéro de téléphone
Définition des attributs par défaut
Pour définir un attribut par défaut pour un utilisateur, appelez la méthode getUser() sur votre instance Braze afin d’obtenir une référence à l’utilisateur actuel de votre application. Vous pouvez ensuite appeler des méthodes pour définir un attribut utilisateur.
1
| braze.getUser().setFirstName("SomeFirstName");
|
1
| braze.getUser().setGender(braze.User.Genders.FEMALE);
|
1
| braze.getUser().setDateOfBirth(2000, 12, 25);
|
Avec Google Tag Manager, les attributs utilisateur standard (tels que le prénom d’un utilisateur) doivent être enregistrés de la même manière que les attributs utilisateur personnalisés. Assurez-vous que les valeurs que vous transmettez pour les attributs standard correspondent au format attendu spécifié dans la documentation de la classe User.
Par exemple, l’attribut genre peut accepter l’une des valeurs suivantes : "m" | "f" | "o" | "u" | "n" | "p". Par conséquent, pour définir le genre d’un utilisateur comme féminin, créez une balise HTML personnalisée avec le contenu suivant :
1
2
3
| <script>
window.braze.getUser().setGender("f")
</script>
|
Suppression des attributs par défaut
Pour supprimer un attribut utilisateur par défaut, transmettez null à la méthode correspondante. Par exemple :
1
| braze.getUser().setFirstName(null);
|
1
| braze.getUser().setGender(null);
|
1
| braze.getUser().setDateOfBirth(null, null, null);
|
Attributs utilisateur personnalisés
Définition des attributs personnalisés
En plus des méthodes d’attributs utilisateur par défaut, vous pouvez également définir des attributs personnalisés pour vos utilisateurs. Pour les spécifications complètes des méthodes, consultez nos JSDocs.
Pour définir un attribut personnalisé avec une valeur de type string :
1
2
3
4
| braze.getUser().setCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
YOUR_STRING_VALUE
);
|
Pour définir un attribut personnalisé avec une valeur de type integer :
1
2
3
4
5
6
7
8
9
10
| braze.getUser().setCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
YOUR_INT_VALUE
);
// Integer attributes may also be incremented using code like the following
braze.getUser().incrementCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
THE_INTEGER_VALUE_BY_WHICH_YOU_WANT_TO_INCREMENT_THE_ATTRIBUTE
);
|
Pour définir un attribut personnalisé avec une valeur de type date :
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
| braze.getUser().setCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
YOUR_DATE_VALUE
);
// This method will assign the current time to a custom attribute at the time the method is called
braze.getUser().setCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
new Date()
);
// This method will assign the date specified by secondsFromEpoch to a custom attribute
braze.getUser().setCustomUserAttribute(
YOUR_ATTRIBUTE_KEY_STRING,
new Date(secondsFromEpoch * 1000)
);
|
Le nombre maximum d’éléments par défaut dans un tableau est de 500. Vous pouvez modifier ce nombre maximum dans le tableau de bord de Braze, sous Paramètres de données > Attributs personnalisés. Les tableaux dépassant le nombre maximum d’éléments sont tronqués pour ne conserver que le nombre maximum d’éléments.
Pour définir un attribut personnalisé avec une valeur de type array :
1
2
3
4
5
6
7
| braze.getUser().setCustomUserAttribute(YOUR_ATTRIBUTE_KEY_STRING, YOUR_ARRAY_OF_STRINGS);
// Adding a new element to a custom attribute with an array value
braze.getUser().addToCustomAttributeArray(YOUR_ATTRIBUTE_KEY_STRING, "new string");
// Removing an element from a custom attribute with an array value
braze.getUser().removeFromCustomAttributeArray(YOUR_ATTRIBUTE_KEY_STRING, "value to be removed");
|
important:
Les dates transmises à Braze avec cette méthode doivent être des objets Date JavaScript.
important:
Les clés et les valeurs des attributs personnalisés ne peuvent pas dépasser 255 caractères. Pour plus d’informations sur les valeurs d’attributs personnalisés valides, consultez la documentation de référence.
Les attributs utilisateur personnalisés ne sont pas disponibles en raison d’une limitation du langage de script de Google Tag Manager. Pour enregistrer des attributs personnalisés, créez une balise HTML personnalisée avec le contenu suivant :
1
2
3
4
5
| <script>
// Note: If using SDK version 3.x or below, use `window.appboy` instead of `window.braze`
// Version 4 or greater should use `window.braze`
window.braze.getUser().setCustomUserAttribute("attribute name", "attribute value");
</script>
|
important:
Le modèle GTM ne prend pas en charge les propriétés imbriquées pour les événements ou les achats. Vous pouvez utiliser le code HTML précédent pour enregistrer les événements ou les achats qui nécessitent des propriétés imbriquées.
Suppression des attributs personnalisés
Pour supprimer un attribut personnalisé, transmettez null à la méthode correspondante.
1
| braze.getUser().setCustomUserAttribute(YOUR_ATTRIBUTE_KEY_STRING, null);
|
Imbrication d’attributs personnalisés
Vous pouvez également imbriquer des propriétés dans des attributs personnalisés. Dans l’exemple suivant, un objet favorite_book avec des propriétés imbriquées est défini comme attribut personnalisé sur le profil utilisateur. Pour plus de détails, consultez la section Attributs personnalisés imbriqués.
1
2
3
4
5
6
7
8
9
| import * as braze from "@braze/web-sdk";
const favoriteBook = {
title: "The Hobbit",
author: "J.R.R. Tolkien",
publishing_date: "1937"
};
braze.getUser().setCustomUserAttribute("favorite_book", favoriteBook);
|
Utiliser l’API REST
Vous pouvez également utiliser notre API REST pour définir ou supprimer des attributs utilisateur. Pour plus d’informations, consultez les endpoints de données utilisateur.
Configuration des abonnements des utilisateurs
Pour configurer un abonnement pour vos utilisateurs (par e-mail ou notification push), appelez respectivement les fonctions setEmailNotificationSubscriptionType() ou setPushNotificationSubscriptionType(). Ces deux fonctions prennent le type enum braze.User.NotificationSubscriptionTypes comme argument. Ce type possède trois états différents :
| Statut d’abonnement |
Définition |
braze.User.NotificationSubscriptionTypes.OPTED_IN |
Abonné et explicitement inscrit |
braze.User.NotificationSubscriptionTypes.SUBSCRIBED |
Abonné, mais pas explicitement inscrit |
braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED |
Désabonné et/ou explicitement désinscrit |
Lorsqu’un utilisateur est enregistré pour les notifications push, le navigateur l’oblige à choisir d’autoriser ou de bloquer les notifications. S’il choisit de les autoriser, son statut est défini sur OPTED_IN par défaut.
Consultez la page Gestion des abonnements des utilisateurs pour plus d’informations sur la mise en œuvre des abonnements et des inscriptions explicites.
Désabonnement d’un utilisateur des e-mails
1
| braze.getUser().setEmailNotificationSubscriptionType(braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED);
|
Désabonnement d’un utilisateur des notifications push
1
| braze.getUser().setPushNotificationSubscriptionType(braze.User.NotificationSubscriptionTypes.UNSUBSCRIBED);
|
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK Android Braze.
Attributs par défaut de l’utilisateur
Méthodes prédéfinies
Braze fournit des méthodes prédéfinies pour définir les attributs utilisateur suivants au sein de la classe BrazeUser. Pour les spécifications relatives aux méthodes, consultez notre KDoc.
- Prénom
- Nom
- Pays
- Langue
- Date de naissance
- E-mail
- Genre
- Ville d’origine
- Numéro de téléphone
note:
Toutes les valeurs de chaîne de caractères telles que le prénom, le nom, le pays et la ville d’origine sont limitées à 255 caractères.
Définition des attributs par défaut
Pour définir un attribut par défaut pour un utilisateur, appelez la méthode getCurrentUser() sur votre instance Braze afin d’obtenir une référence à l’utilisateur actuel de votre application. Vous pouvez ensuite appeler des méthodes pour définir un attribut utilisateur.
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setFirstName("first_name");
}
}
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setFirstName("first_name")
}
|
Suppression des attributs par défaut
Pour supprimer un attribut utilisateur, transmettez null à la méthode appropriée.
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setFirstName(null);
}
}
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setFirstName(null)
}
|
Attributs utilisateur personnalisés
En plus des attributs utilisateur par défaut, Braze vous permet de définir des attributs personnalisés à l’aide de plusieurs types de données différents. Pour plus d’informations sur les options de segmentation de chaque attribut, consultez la section Collecte des données utilisateur.
Définition des attributs personnalisés
Pour définir un attribut personnalisé avec une valeur string :
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", "your_attribute_value");
}
}
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", "your_attribute_value")
}
|
Pour définir un attribut personnalisé avec une valeur int :
1
2
3
4
5
6
7
8
9
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_INT_VALUE);
// Integer attributes may also be incremented using code like the following:
brazeUser.incrementCustomUserAttribute("your_attribute_key", YOUR_INCREMENT_VALUE);
}
}
|
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_INT_VALUE)
// Integer attributes may also be incremented using code like the following:
brazeUser.incrementCustomUserAttribute("your_attribute_key", YOUR_INCREMENT_VALUE)
}
|
Pour définir un attribut personnalisé avec une valeur entière long :
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_LONG_VALUE);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_LONG_VALUE)
}
|
Pour définir un attribut personnalisé avec une valeur float :
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_FLOAT_VALUE);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_FLOAT_VALUE)
}
|
Pour définir un attribut personnalisé avec une valeur double :
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DOUBLE_VALUE);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DOUBLE_VALUE)
}
|
Pour définir un attribut personnalisé avec une valeur boolean :
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_BOOLEAN_VALUE);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_BOOLEAN_VALUE)
}
|
1
2
3
4
5
6
7
8
9
10
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DATE_VALUE);
// This method will assign the current time to a custom attribute at the time the method is called:
brazeUser.setCustomUserAttributeToNow("your_attribute_key");
// This method will assign the date specified by SECONDS_FROM_EPOCH to a custom attribute:
brazeUser.setCustomUserAttributeToSecondsFromEpoch("your_attribute_key", SECONDS_FROM_EPOCH);
}
});
|
1
2
3
4
5
6
7
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setCustomUserAttribute("your_attribute_key", YOUR_DATE_VALUE)
// This method will assign the current time to a custom attribute at the time the method is called:
brazeUser.setCustomUserAttributeToNow("your_attribute_key")
// This method will assign the date specified by SECONDS_FROM_EPOCH to a custom attribute:
brazeUser.setCustomUserAttributeToSecondsFromEpoch("your_attribute_key", SECONDS_FROM_EPOCH)
}
|
warning:
Les dates transmises à Braze avec cette méthode doivent être au format ISO 8601 (par ex. 2013-07-16T19:20:30+01:00) ou au format yyyy-MM-dd'T'HH:mm:ss:SSSZ (par ex. 2016-12-14T13:32:31.601-0800).
Le nombre maximum d’éléments par défaut dans un tableau est de 500. Vous pouvez modifier ce maximum dans le tableau de bord de Braze, sous Paramètres des données > Attributs personnalisés. Les tableaux dépassant le nombre maximum d’éléments sont tronqués pour ne contenir que le nombre maximum d’éléments. Pour plus d’informations sur les tableaux d’attributs personnalisés et leur comportement, consultez la section Tableaux.
1
2
3
4
5
6
7
8
9
10
11
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
// Setting a custom attribute with an array value
brazeUser.setCustomAttributeArray("your_attribute_key", testSetArray);
// Adding to a custom attribute with an array value
brazeUser.addToCustomAttributeArray("your_attribute_key", "value_to_add");
// Removing a value from an array type custom attribute
brazeUser.removeFromCustomAttributeArray("your_attribute_key", "value_to_remove");
}
});
|
1
2
3
4
5
6
7
8
| Braze.getInstance(context).getCurrentUser { brazeUser ->
// Setting a custom attribute with an array value
brazeUser.setCustomAttributeArray("your_attribute_key", testSetArray)
// Adding to a custom attribute with an array value
brazeUser.addToCustomAttributeArray("your_attribute_key", "value_to_add")
// Removing a value from an array type custom attribute
brazeUser.removeFromCustomAttributeArray("your_attribute_key", "value_to_remove")
}
|
Suppression des attributs personnalisés
Pour supprimer un attribut personnalisé, transmettez la clé d’attribut correspondante à la méthode unsetCustomUserAttribute.
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.unsetCustomUserAttribute("your_attribute_key");
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.unsetCustomUserAttribute("your_attribute_key")
}
|
Imbrication d’attributs personnalisés
Vous pouvez également imbriquer des propriétés dans des attributs personnalisés. Dans l’exemple suivant, un objet favorite_book avec des propriétés imbriquées est défini comme attribut personnalisé sur le profil utilisateur. Pour plus de détails, consultez la section Attributs personnalisés imbriqués.
1
2
3
4
5
6
7
8
9
10
11
12
13
| JSONObject favoriteBook = new JSONObject();
try {
favoriteBook.put("title", "The Hobbit");
favoriteBook.put("author", "J.R.R. Tolkien");
favoriteBook.put("publishing_date", "1937");
} catch (JSONException e) {
e.printStackTrace();
}
braze.getCurrentUser(user -> {
user.setCustomUserAttribute("favorite_book", favoriteBook);
return null;
});
|
1
2
3
4
5
6
7
8
| val favoriteBook = JSONObject()
.put("title", "The Hobbit")
.put("author", "J.R.R. Tolkien")
.put("publishing_date", "1937")
braze.getCurrentUser { user ->
user.setCustomUserAttribute("favorite_book", favoriteBook)
}
|
Utiliser l’API REST
Vous pouvez également utiliser notre API REST pour définir ou supprimer des attributs utilisateur. Pour plus d’informations, consultez les endpoints de données utilisateur.
Configuration des abonnements des utilisateurs
Pour configurer un abonnement pour vos utilisateurs (par e-mail ou notification push), appelez respectivement les fonctions setEmailNotificationSubscriptionType() ou setPushNotificationSubscriptionType(). Ces deux fonctions prennent le type enum NotificationSubscriptionType comme argument. Ce type possède trois états différents :
| État de l’abonnement |
Définition |
OPTED_IN |
Abonné et explicitement inscrit |
SUBSCRIBED |
Abonné, mais pas explicitement inscrit |
UNSUBSCRIBED |
Désabonné et/ou explicitement désinscrit |
important:
Aucun abonnement explicite n’est requis par Android pour envoyer des notifications push aux utilisateurs. Lorsqu’un utilisateur est enregistré pour les notifications push, son statut est défini sur SUBSCRIBED plutôt que OPTED_IN par défaut. Consultez la section Gestion des abonnements des utilisateurs pour plus d’informations sur la mise en œuvre des abonnements et des inscriptions explicites.
Définir les abonnements par e-mail
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setEmailNotificationSubscriptionType(emailNotificationSubscriptionType);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setEmailNotificationSubscriptionType(emailNotificationSubscriptionType)
}
|
Définir l’abonnement aux notifications push
1
2
3
4
5
6
| Braze.getInstance(context).getCurrentUser(new IValueCallback<BrazeUser>() {
@Override
public void onSuccess(BrazeUser brazeUser) {
brazeUser.setPushNotificationSubscriptionType(pushNotificationSubscriptionType);
}
});
|
1
2
3
| Braze.getInstance(context).getCurrentUser { brazeUser ->
brazeUser.setPushNotificationSubscriptionType(pushNotificationSubscriptionType)
}
|
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK Swift Braze.
Attributs par défaut de l’utilisateur
Attributs pris en charge
Les attributs suivants doivent être définis sur l’objet Braze.User :
firstName
lastName
email
dateOfBirth
country
language
homeCity
phone
gender
Définition des attributs par défaut
Pour définir un attribut par défaut, configurez le champ approprié sur l’objet partagé Braze.User. Voici un exemple montrant comment définir l’attribut de prénom :
1
| AppDelegate.braze?.user.set(firstName: "Alex")
|
1
| [AppDelegate.braze.user setFirstName:@"Alex"];
|
Suppression des attributs par défaut
Pour supprimer un attribut par défaut, transmettez nil à la méthode correspondante.
1
| AppDelegate.braze?.user.set(firstName: nil)
|
1
| [AppDelegate.braze.user setFirstName:nil];
|
Attributs personnalisés
En plus des attributs par défaut, Braze vous permet de définir des attributs personnalisés à l’aide de plusieurs types de données. Pour en savoir plus sur les options de segmentation de chaque attribut, consultez la section Collecte des données utilisateur.
important:
Les valeurs d’attribut personnalisé ont une longueur maximale de 255 caractères ; les valeurs plus longues seront tronquées. Pour plus d’informations, consultez Braze.User.
Définition des attributs personnalisés
Pour définir un attribut personnalisé avec une valeur de type string :
1
| AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: "your_attribute_value")
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" stringValue:"your_attribute_value"];
|
Pour définir un attribut personnalisé avec une valeur de type integer :
1
| AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: yourIntegerValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andIntegerValue:yourIntegerValue];
|
Braze traite les valeurs float et double de la même manière dans sa base de données. Pour définir un attribut personnalisé avec une valeur double :
1
| AppDelegate.braze?.user.setCustomAttribute(key: "your_attribute_key", value: yourDoubleValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andDoubleValue:yourDoubleValue];
|
Pour définir un attribut personnalisé avec une valeur de type boolean :
1
| AppDelegate.braze?.user.setCustomAttribute("your_attribute_key", value: yourBoolValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andBOOLValue:yourBOOLValue];
|
Pour définir un attribut personnalisé avec une valeur de type date :
1
| AppDelegate.braze?.user.setCustomAttribute("your_attribute_key", dateValue:yourDateValue)
|
1
| [AppDelegate.braze.user setCustomAttributeWithKey:@"your_attribute_key" andDateValue:yourDateValue];
|
Le nombre maximum d’éléments par défaut dans un tableau est de 500. Vous pouvez modifier ce nombre maximum dans le tableau de bord de Braze, sous Paramètres des données > Attributs personnalisés. Les tableaux dépassant le nombre maximum d’éléments seront tronqués pour ne conserver que le nombre maximum d’éléments.
Pour définir un attribut personnalisé avec une valeur de type array :
1
2
3
4
5
6
| // Setting a custom attribute with an array value
AppDelegate.braze?.user.setCustomAttributeArray(key: "array_name", array: ["value1", "value2"])
// Adding to a custom attribute with an array value
AppDelegate.braze?.user.addToCustomAttributeArray(key: "array_name", value: "value3")
// Removing a value from an array type custom attribute
AppDelegate.braze?.user.removeFromCustomAttributeArray(key: "array_name", value: "value2")
|
1
2
3
4
5
6
7
8
| // Setting a custom attribute with an array value
[AppDelegate.braze.user setCustomAttributeArrayWithKey:@"array_name" array:@[@"value1", @"value2"]];
// Adding to a custom attribute with an array value
[AppDelegate.braze.user addToCustomAttributeArrayWithKey:@"array_name" value:@"value3"];
// Removing a value from an array type custom attribute
[AppDelegate.braze.user removeFromCustomAttributeArrayWithKey:@"array_name" value:@"value2"];
// Removing an entire array and key
[AppDelegate.braze.user setCustomAttributeArrayWithKey:@"array_name" array:nil];
|
Incrémentation ou décrémentation des attributs personnalisés
Ce code illustre l’incrémentation d’un attribut personnalisé. Vous pouvez incrémenter la valeur d’un attribut personnalisé de n’importe quelle valeur integer ou long :
1
| AppDelegate.braze?.user.incrementCustomUserAttribute(key: "your_attribute_key", by: incrementIntegerValue)
|
1
| [AppDelegate.braze.user incrementCustomUserAttribute:@"your_attribute_key" by:incrementIntegerValue];
|
Suppression des attributs personnalisés
Pour supprimer un attribut personnalisé, transmettez la clé d’attribut correspondante à la méthode unsetCustomAttribute.
1
| AppDelegate.braze?.user.unsetCustomAttribute(key: "your_attribute_key")
|
Pour supprimer un attribut personnalisé, transmettez la clé d’attribut correspondante à la méthode unsetCustomAttributeWithKey.
1
| [AppDelegate.braze.user unsetCustomAttributeWithKey:@"your_attribute_key"];
|
Imbrication d’attributs personnalisés
Vous pouvez également imbriquer des propriétés dans des attributs personnalisés. Dans l’exemple suivant, un objet favorite_book avec des propriétés imbriquées est défini comme attribut personnalisé sur le profil utilisateur. Pour plus de détails, consultez la section Attributs personnalisés imbriqués.
1
2
3
4
5
6
7
| let favoriteBook: [String: Any?] = [
"title": "The Hobbit",
"author": "J.R.R. Tolkien",
"publishing_date": "1937"
]
braze.user.setCustomAttribute(key: "favorite_book", dictionary: favoriteBook)
|
1
2
3
4
5
6
7
| NSDictionary *favoriteBook = @{
@"title": @"The Hobbit",
@"author": @"J.R.R. Tolkien",
@"publishing_date": @"1937"
};
[AppDelegate.braze.user setCustomAttributeWithKey:@"favorite_book" dictionary:favoriteBook];
|
Utilisation de l’API REST
Vous pouvez également utiliser notre API REST pour définir ou supprimer des attributs utilisateur. Pour plus d’informations, reportez-vous aux endpoints de données utilisateur.
Configuration des abonnements utilisateur
Pour configurer un abonnement pour vos utilisateurs (par e-mail ou notification push), appelez respectivement les fonctions set(emailSubscriptionState:) ou set(pushNotificationSubscriptionState:). Ces deux fonctions prennent le type enum Braze.User.SubscriptionState comme argument. Ce type comporte trois états :
| État d’abonnement |
Définition |
optedIn |
Abonné et explicitement inscrit |
subscribed |
Abonné, mais pas explicitement inscrit |
unsubscribed |
Désabonné et/ou explicitement désinscrit |
Les utilisateurs qui autorisent une application à leur envoyer des notifications push ont par défaut le statut optedIn, car iOS exige un abonnement explicite.
Les utilisateurs sont automatiquement définis sur subscribed dès la réception d’une adresse e-mail valide. Nous vous recommandons toutefois de mettre en place un processus d’abonnement explicite et de définir cette valeur sur optedIn dès réception du consentement explicite de votre utilisateur. Reportez-vous à Gérer les abonnements des utilisateurs pour plus de détails.
Définition des abonnements par e-mail
1
| AppDelegate.braze?.user.set(emailSubscriptionState: Braze.User.SubscriptionState)
|
1
| [AppDelegate.braze.user setEmailSubscriptionState: BRZUserSubscriptionState]
|
Définition des abonnements aux notifications push
1
| AppDelegate.braze?.user.set(pushNotificationSubscriptionState: Braze.User.SubscriptionState)
|
1
| [AppDelegate.braze.user setPushNotificationSubscriptionState: BRZUserSubscriptionState]
|
Reportez-vous à Gérer les abonnements des utilisateurs pour plus de détails.
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK de Flutter Braze.
Attributs par défaut de l’utilisateur
Attributs pris en charge
Les attributs suivants sont pris en charge :
- Prénom
- Nom
- Genre
- Date de naissance
- Ville d’origine
- Pays
- Numéro de téléphone
- Langue
- E-mail
important:
Toutes les valeurs de chaîne de caractères telles que le prénom, le nom de famille, le pays et la ville d’origine sont limitées à 255 caractères.
Définition des attributs par défaut
Pour définir les attributs utilisateur collectés automatiquement par Braze, vous pouvez utiliser les méthodes setter incluses dans le SDK.
1
| braze.setFirstName('Name');
|
Attributs utilisateur personnalisés
Définition des attributs personnalisés
Outre les attributs par défaut, Braze vous permet de définir des attributs personnalisés à l’aide de différents types de données :
Pour définir un attribut personnalisé avec une valeur string:
1
| braze.setStringCustomUserAttribute("custom string attribute", "string custom attribute");
|
Pour définir un attribut personnalisé avec une valeur integer:
1
2
3
4
| // Set Integer Attribute
braze.setIntCustomUserAttribute("custom int attribute key", integer);
// Increment Integer Attribute
braze.incrementCustomUserAttribute("key", integer);
|
Pour définir un attribut personnalisé avec une valeur double:
1
| braze.setDoubleCustomUserAttribute("custom double attribute key", double);
|
Pour définir un attribut personnalisé avec une valeur boolean:
1
| braze.setBoolCustomUserAttribute("custom boolean attribute key", boolean);
|
Pour définir un attribut personnalisé avec une valeur date:
1
| braze.setDateCustomUserAttribute("custom date attribute key", date);
|
Pour définir un attribut personnalisé avec une valeur array:
1
2
3
4
| // Adding to an Array
braze.addToCustomAttributeArray("key", "attribute");
// Removing an item from an Array
braze.removeFromCustomAttributeArray("key", "attribute");
|
important:
Les valeurs d’attribut personnalisé ont une longueur maximale de 255 caractères ; les valeurs plus longues seront tronquées.
Désactivation des attributs personnalisés
Pour désactiver un attribut personnalisé, transmettez la clé de l’attribut concerné à la méthode unsetCustomUserAttribute.
1
| braze.unsetCustomUserAttribute('attribute_key');
|
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK Roku Braze.
Attributs par défaut de l’utilisateur
Méthodes prédéfinies
Braze propose des méthodes prédéfinies pour définir les attributs utilisateur suivants à l’aide de l’objet m.Braze.
FirstName
LastName
Email
Gender
DateOfBirth
Country
Language
HomeCity
PhoneNumber
Définition des attributs par défaut
Pour définir un attribut par défaut, appelez la méthode correspondante sur l’objet m.Braze.
1
| m.Braze.setFirstName("Alex")
|
1
| m.Braze.setLastName("Smith")
|
1
| m.Braze.setGender("m") ' Accepts: "m", "f", "o", "n", "u", "p"
|
1
| m.Braze.setDateOfBirth(1990, 5, 15) ' Year, month, day
|
1
| m.Braze.setCountry("United States")
|
1
| m.Braze.setLanguage("en")
|
1
| m.Braze.setHomeCity("New York")
|
1
| m.Braze.setPhoneNumber("+1234567890")
|
Attributs utilisateur personnalisés
Outre les attributs par défaut, Braze vous permet de définir des attributs personnalisés à l’aide de différents types de données.
Définition des attributs personnalisés
Pour donner à un attribut personnalisé une valeur string:
1
| m.Braze.setCustomAttribute("stringAttribute", "stringValue")
|
Pour définir un attribut personnalisé avec une valeur integer:
1
| m.Braze.setCustomAttribute("intAttribute", 5)
|
Braze traite les valeurs float et double exactement de la même manière. Pour définir un attribut personnalisé avec l’une ou l’autre valeur :
1
| m.Braze.setCustomAttribute("floatAttribute", 3.5)
|
Pour définir un attribut personnalisé avec une valeur boolean:
1
| m.Braze.setCustomAttribute("boolAttribute", true)
|
Pour définir un attribut personnalisé avec une valeur date:
1
2
3
| dateAttribute = CreateObject("roDateTime")
dateAttribute.fromISO8601String("1992-11-29 00:00:00.000")
m.Braze.setCustomAttribute("dateAttribute", dateAttribute)
|
Pour définir un attribut personnalisé avec une valeur array:
1
2
3
4
5
| stringArray = createObject("roArray", 3, true)
stringArray.Push("string1")
stringArray.Push("string2")
stringArray.Push("string3")
m.Braze.setCustomAttribute("arrayAttribute", stringArray)
|
important:
Les valeurs d’attribut personnalisé ont une longueur maximale de 255 caractères ; les valeurs plus longues seront tronquées.
Incrémentation et décrémentation des attributs personnalisés
Ce code est un exemple d’incrémentation d’un attribut personnalisé. Vous pouvez augmenter la valeur d’un attribut personnalisé par une valeur entière positive ou négative.
1
| m.Braze.incrementCustomUserAttribute("intAttribute", 3)
|
Désactivation des attributs personnalisés
Pour désactiver un attribut personnalisé, transmettez la clé de l’attribut concerné à la méthode unsetCustomAttribute.
1
| m.Braze.unsetCustomAttribute("attributeName")
|
Utiliser l’API REST
Vous pouvez également utiliser notre API REST pour définir ou désactiver les attributs des utilisateurs. Pour plus d’informations, reportez-vous aux Endpoints de données utilisateur.
Définir des inscriptions par e-mail
Vous pouvez définir les statuts d’abonnement aux e-mails suivants pour vos utilisateurs par programmation via le SDK.
| Statut d’abonnement |
Définition |
OptedIn |
Inscrit et explicitement abonné |
Subscribed |
Inscrit et pas explicitement abonné |
UnSubscribed |
Désinscrit ou explicitement désabonné |
note:
Ces types tombent dans la catégorie BrazeConstants().SUBSCRIPTION_STATES.
La méthode de définition du statut d’abonnement aux e-mails est setEmailSubscriptionState(). Les utilisateurs seront définis sur Subscribed automatiquement dès réception d’une adresse e-mail valide. Cependant, nous vous suggérons d’établir un processus d’abonnement explicite et de définir cette valeur sur OptedIn dès réception du consentement explicite de votre utilisateur. Pour plus de détails, consultez la page Gestion des abonnements des utilisateurs.
1
| m.Braze.setEmailSubscriptionState(BrazeConstants().SUBSCRIPTION_STATES.OPTED_IN)
|
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devez intégrer le SDK d’Unity Braze.
Attributs par défaut de l’utilisateur
Méthodes prédéfinies
Braze propose des méthodes prédéfinies pour définir les attributs utilisateur suivants à l’aide de l’objet BrazeBinding. Pour plus d’informations, consultez le fichier de déclaration de Braze Unity.
- Prénom
- Nom
- Adresse e-mail de l’utilisateur
- Genre
- Date de naissance
- Pays de l’utilisateur
- Ville de résidence de l’utilisateur
- Abonnement de l’utilisateur aux e-mails
- Abonnement de l’utilisateur aux notifications push
- Numéro de téléphone de l’utilisateur
Définition des attributs par défaut
Pour définir un attribut par défaut, appelez la méthode correspondante sur l’objet BrazeBinding.
1
| BrazeBinding.SetUserFirstName("first name");
|
1
| BrazeBinding.SetUserLastName("last name");
|
1
| BrazeBinding.SetUserGender(Appboy.Models.Gender);
|
1
| BrazeBinding.SetUserDateOfBirth("year(int)", "month(int)", "day(int)");
|
1
| BrazeBinding.SetUserCountry("country name");
|
1
| BrazeBinding.SetUserHomeCity("city name");
|
1
| BrazeBinding.SetUserEmailNotificationSubscriptionType(AppboyNotificationSubscriptionType);
|
1
| BrazeBinding.SetUserPushNotificationSubscriptionType(AppboyNotificationSubscriptionType);
|
1
| BrazeBinding.SetUserPhoneNumber("phone number");
|
Désactivation des attributs par défaut
Pour désactiver un attribut par défaut de l’utilisateur, passez null à la méthode correspondante.
1
| BrazeBinding.SetUserFirstName(null);
|
Attributs utilisateur personnalisés
Outre les attributs par défaut, Braze vous permet de définir des attributs personnalisés à l’aide de différents types de données. Pour plus d’informations sur l’option de segmentation de chaque attribut, voir Collecte de données sur les utilisateurs.
Définition des attributs personnalisés
Pour définir un attribut personnalisé, utilisez la méthode correspondant au type d’attribut :
1
| AppboyBinding.SetCustomUserAttribute("custom string attribute key", "string custom attribute");
|
1
2
3
4
| // Set Integer Attribute
AppboyBinding.SetCustomUserAttribute("custom int attribute key", 'integer value');
// Increment Integer Attribute
AppboyBinding.IncrementCustomUserAttribute("key", increment(int))
|
1
| AppboyBinding.SetCustomUserAttribute("custom double attribute key", 'double value');
|
1
| AppboyBinding.SetCustomUserAttribute("custom boolean attribute key", 'boolean value');
|
1
| AppboyBinding.SetCustomUserAttributeToNow("custom date attribute key");
|
1
| AppboyBinding.SetCustomUserAttributeToSecondsFromEpoch("custom date attribute key", 'integer value');
|
note:
Les dates transmises à Braze doivent être au format ISO 8601 (par exemple 2013-07-16T19:20:30+01:00) ou au format yyyy-MM-dd'T'HH:mm:ss:SSSZ (par exemple2016-12-14T13:32:31.601-0800).
1
2
3
4
5
6
| // Setting An Array
AppboyBinding.SetCustomUserAttributeArray("key", array(List), sizeOfTheArray(int))
// Adding to an Array
AppboyBinding.AddToCustomUserAttributeArray("key", "Attribute")
// Removing an item from an Array
AppboyBinding.RemoveFromCustomUserAttributeArray("key", "Attribute")
|
important:
Les valeurs d’attribut personnalisé ont une longueur maximale de 255 caractères ; les valeurs plus longues seront tronquées.
Désactivation des attributs personnalisés
Pour désactiver un attribut personnalisé, transmettez la clé de l’attribut concerné à la méthode UnsetCustomUserAttribute.
1
| AppboyBinding.UnsetCustomUserAttribute("custom attribute key");
|
Utiliser l’API REST
Vous pouvez également utiliser notre API REST pour définir ou désactiver les attributs des utilisateurs. Pour plus d’informations, reportez-vous aux Endpoints de données utilisateur.
Pour configurer un abonnement e-mail ou push pour vos utilisateurs, appelez l’une des fonctions suivantes.
1
2
3
4
5
| // Email notifications
AppboyBinding.SetUserEmailNotificationSubscriptionType()
// Push notifications
AppboyBinding.SetPushNotificationSubscriptionType()`
|
Les deux fonctions prennent comme argument Appboy.Models.AppboyNotificationSubscriptionType, qui a trois états différents :
| Statut de l’abonnement |
Définition |
OPTED_IN |
Inscrit et explicitement abonné |
SUBSCRIBED |
Inscrit et pas explicitement abonné |
UNSUBSCRIBED |
Désinscrit ou explicitement désabonné |
note:
Aucun abonnement explicite n’est requis par Windows pour envoyer des notifications push aux utilisateurs. Lorsqu’un utilisateur est enregistré pour les notifications push, il est défini sur SUBSCRIBED plutôt que OPTED_IN par défaut. Pour en savoir plus, consultez notre documentation sur l’implémentation des souscriptions et des abonnements explicites.
| Type d’abonnement |
Description |
EmailNotificationSubscriptionType |
Les utilisateurs seront définis sur SUBSCRIBED automatiquement à la réception d’une adresse e-mail valide. Cependant, nous vous suggérons d’établir un processus d’abonnement explicite et de définir cette valeur sur OPTED_IN dès réception du consentement explicite de votre utilisateur. Pour plus de détails, consultez notre documentation Modification des souscriptions utilisateur. |
PushNotificationSubscriptionType |
Les utilisateurs seront définis sur SUBSCRIBED automatiquement après une inscription aux notifications push valide. Cependant, nous vous suggérons d’établir un processus d’abonnement explicite et de définir cette valeur sur OPTED_IN dès réception du consentement explicite de votre utilisateur. Pour plus de détails, consultez notre documentation Modification des souscriptions utilisateur. |
note:
Ces types tombent dans la catégorie Appboy.Models.AppboyNotificationSubscriptionType.
Définir des inscriptions par e-mail
1
| AppboyBinding.SetUserEmailNotificationSubscriptionType(AppboyNotificationSubscriptionType.OPTED_IN);
|
Définition des abonnements par notification push
1
| AppboyBinding.SetUserPushNotificationSubscriptionType(AppboyNotificationSubscriptionType.OPTED_IN);
|
Conditions préalables
Avant de pouvoir utiliser cette fonctionnalité, vous devrez intégrer le SDK React Native Braze.
Enregistrer des attributs personnalisés
Braze fournit des méthodes pour assigner des attributs aux utilisateurs. Vous pourrez filtrer et segmenter vos utilisateurs en fonction de ces attributs sur le tableau de bord.
Attributs par défaut de l’utilisateur
Pour définir les attributs utilisateur automatiquement collectés par Braze, vous pouvez utiliser les méthodes de configuration fournies avec le SDK.
1
| Braze.setFirstName("Name");
|
Les attributs suivants sont pris en charge :
- Prénom
- Nom
- Genre
- Date de naissance
- Ville d’origine
- Pays
- Numéro de téléphone
- Langue
- E-mail
Toutes les valeurs de chaîne de caractères telles que le prénom, le nom de famille, le pays et la ville d’origine sont limitées à 255 caractères.
Attributs utilisateur personnalisés
En plus de nos méthodes prédéfinies d’attributs utilisateur, Braze fournit également des attributs personnalisés pour suivre les données de vos applications.
1
2
3
| Braze.setCustomUserAttribute("attribute_key", "attribute_value", function(){
// optional onResult callback
});
|
Suppression des attributs personnalisés
1
2
3
| Braze.unsetCustomUserAttribute("attribute_key", function(){
// optional onResult callback
});
|
Tableaux d’attribut personnalisé
1
2
3
4
5
6
7
8
|
// Adds a string to a custom attribute string array, or creates that array if one doesn't exist.
Braze.addToCustomUserAttributeArray("my-attribute-array", "new or existing value", optionalCallback);
// Removes a string from a custom attribute string array.
Braze.removeFromCustomUserAttributeArray("my-attribute-array", "existing value", optionalCallback);
|