Objeto Android
O objeto
android_push
permite que você defina ou solicite informações relacionadas ao conteúdo do Android Push e do Android Push Alert por meio de nossos pontos de extremidade de envio de mensagens.
Objeto push do Android
É necessário incluir um objeto Android push em messages
se quiser que os usuários direcionados recebam um push em seus dispositivos Android. O número total de bytes em sua string alert
e no objeto extra
não deve exceder 4.000. A API de envio de mensagens retornará um erro se você exceder o tamanho de mensagem permitido pelo Google.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
"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 will be 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 will 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 will play 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,
"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 will only send 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.
}
Você pode enviar notificações “Big Picture” especificando a chave appboy_image_url
no objeto extra
. O valor para appboy_image_url
deve ser um URL com link para o local onde sua imagem está hospedada. As imagens precisam ser cortadas em uma proporção de 2:1 e devem ter no mínimo 600 x 300 px.
Detalhes de parâmetros adicionais
Parâmetro | Informações |
---|---|
priority |
Esse parâmetro aceitará valores de -2 a 2 , em que -2 representa a prioridade “MIN” e 2 representa “MAX”. 0 é o valor “DEFAULT”. Todos os valores enviados fora desse intervalo terão como padrão o valor 0. Para saber mais sobre o nível de prioridade a ser usado, consulte Prioridade de notificação do Android. |
android_priority |
Esse parâmetro aceitará valores “normal” ou “alto” para especificar a prioridade do remetente FCM. Por padrão, as mensagens de notificação são enviadas com prioridade alta e as mensagens de dados são enviadas com prioridade normal. Para saber mais sobre como os diferentes valores afetam a entrega, consulte Prioridade de mensagens do Android. |
collapse_key |
O FCM pode armazenar simultaneamente até quatro chaves de colapso por dispositivo. Se você usar mais de quatro chaves de colapso, a FCM não garante quais delas serão mantidas. A Braze usa uma delas por padrão para as campanhas, por isso especifique apenas até três chaves de colapso adicionais para as mensagens do Android. |
push_icon_image_url |
O valor do parâmetro do ícone grande deve ser um URL com link para o local onde sua imagem está hospedada. As imagens precisam ser cortadas em uma proporção de 1:1 e devem ter no mínimo 40x40. |
notification_channel |
Se isso não for especificado, a Braze tentará enviar a carga útil da notificação com o ID do canal dashboard fallback. Para saber mais, consulte Canais de notificação e as etapas para definir canais de notificação durante a integração. |
send_to_sync |
Para saber mais sobre o envio de mensagens para send_to_sync , consulte notificações silenciosas do Android. |
Objeto de botão de ação por push do 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
}
Objeto push de conversa do Android
Os conceitos desta mensagem correspondem aos da documentação de 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)
}
Objeto de mensagem push de conversação do 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,
}
Objeto de pessoa push de conversa no Android
1
2
3
4
{
"id" : (required, string) the identifier of this Person,
"name" : (required, string) the display name of this Person
}