Objet Android
L’objet
android_pushvous permet de définir ou de demander des informations relatives au contenu Android Push et Android Push Alert par le biais de nos endpoints de messagerie.
Objet notification push Android
Vous devez inclure un objet Android push dans messages si vous souhaitez que les utilisateurs que vous avez ciblés reçoivent une notification push sur leurs appareils Android. Le nombre total d’octets de votre chaîne de caractères alert et de votre objet extra ne doit pas dépasser 4 000. L’API de messagerie renvoie une erreur si vous dépassez la taille de message autorisée par Google.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"alert": (required, string) the notification message,
"title": (required, string) the title that appears in the notification drawer,
"extra": (optional, object) additional keys and values to be sent in the push,
"message_variation_id": (optional, string) used when providing a campaign_id to specify which message variation this message should be tracked under (must be an Android Push Message),
"notification_channel_id": (optional, string) the channel ID the notification is sent with,
"priority": (optional, integer) the notification priority value,
"android_priority": (optional, string) the FCM sender priority,
"send_to_sync": (optional, if set to true we throw an error if "alert" or "title" is set),
"collapse_key": (optional, string) the collapse key for this message,
// Specifying "default" in the sound field plays the standard notification sound
"sound": (optional, string) the location of a custom notification sound within the app,
"custom_uri": (optional, string) a web URL, or Deep Link URI,
"use_webview": (optional, boolean) whether to open the web URL inside the app if the action is "URI", defaults to false,
"summary_text": (optional, string),
"time_to_live": (optional, integer (maximum of 2,419,200 seconds)),
"notification_id": (optional, integer),
"push_icon_image_url": (optional, string) an image URL for the large icon,
"accent_color": (optional, integer) accent color to be applied by the standard Style templates when presenting this notification, an RGB integer value,
"send_to_most_recent_device_only": (optional, boolean) defaults to false, if set to true, Braze only sends this push to a user's most recently used Android device, rather than all eligible Android devices,
"buttons" : (optional, array of Android push action button objects) push action buttons to display
"conversation_data" : (optional, Android Conversation Push Object) the data to be displayed through Conversation Push
}
Vous pouvez envoyer des notifications « Big Picture » en spécifiant la clé appboy_image_url dans l’objet extra. La valeur de appboy_image_url doit être une URL qui renvoie à l’emplacement où votre image est hébergée. Les images doivent être recadrées selon un rapport hauteur/largeur de 2:1 et mesurer au moins 600 x 300 px.
Informations complémentaires sur les paramètres
| Paramètre | Détails |
|---|---|
priority |
Ce paramètre accepte des valeurs comprises entre -2 et 2, où -2 représente la priorité « MIN » et 2 la priorité « MAX ». 0 est la valeur « DEFAULT ». Toutes les valeurs envoyées en dehors de cette plage prennent par défaut la valeur 0. Pour plus d’informations sur le niveau de priorité à utiliser, consultez Priorité des notifications Android. |
android_priority |
Ce paramètre accepte les valeurs normal ou high pour spécifier la priorité de l’expéditeur FCM. Par défaut, les messages sont envoyés avec la priorité FCM par défaut configurée dans la page Paramètres de notifications push.Pour plus d’informations sur l’impact des différentes valeurs sur la distribution, consultez Priorité des messages Android. |
collapse_key |
Le FCM ne peut stocker simultanément que quatre clés de réduction par appareil. Si vous en utilisez plus de quatre, le FCM ne garantit pas lesquelles seront conservées. Braze en utilise une par défaut pour les campagnes, veillez donc à ne spécifier que trois clés de réduction supplémentaires au maximum pour les messages Android. |
push_icon_image_url |
La valeur du paramètre de grande icône doit être une URL qui renvoie à l’emplacement où votre image est hébergée. Les images doivent être recadrées selon un rapport hauteur/largeur de 1:1 et mesurer au moins 40x40. |
notification_channel |
Si ce paramètre n’est pas spécifié, Braze tente d’envoyer le payload de notification avec l’ID du canal de repli du tableau de bord. Pour en savoir plus, consultez Canaux de notification et reportez-vous aux étapes de définition des canaux de notification lors de l’intégration. |
send_to_sync |
Pour plus d’informations sur les messages send_to_sync, consultez Notifications push silencieuses Android. |
Objet bouton d’action push Android
1
2
3
4
5
6
{
"text": (required, string) the button's text,
"action": (optional, string) one of "OPEN_APP", "URI", "DEEP_LINK", or "CLOSE", defaults to "OPEN_APP",
"uri": (optional, string) a web URL or Deep Link URI,
"use_webview": (optional, boolean) whether to open the web URL inside the app if the action is "URI", defaults to true
}
Objet notification push de conversation Android
Les concepts présentés dans ce message correspondent à ceux de la documentation push Android People and Conversations.
1
2
3
4
5
6
{
"shortcut_id" : (required, string) the sharing shortcut identifier,
"reply_person_id" : (required, string) the identifier of the Person this push is replying to,
"messages" : (required, array of Android Conversation Push Message Object),
"persons" : (required, array of Android Conversation Push Person Object)
}
Objet message de notification push de conversation Android
1
2
3
4
5
{
"text" : (required, string) the text of this message,
"timestamp" : (required, integer) the unix timestamp of when this message was sent,
"person_id" : (required, string) the Person identifier of this message's sender,
}
Objet personne de notification push de conversation Android
1
2
3
4
{
"id" : (required, string) the identifier of this Person,
"name" : (required, string) the display name of this Person
}