Android-Objekt
Mit dem Objekt
android_pushkönnen Sie über unsere Messaging-Endpunkte Informationen zu Android-Push- und Android-Push-Alert-Inhalten definieren oder anfragen.
Android-Push-Objekt
Sie müssen ein Android-Push-Objekt in messages einfügen, wenn die von Ihnen angesprochenen Nutzer:innen eine Push-Nachricht auf ihren Android-Geräten erhalten sollen. Die Gesamtanzahl der Bytes in Ihrem alert-String und dem extra-Objekt sollte 4.000 nicht überschreiten. Die Messaging-API gibt einen Fehler zurück, wenn Sie die von Google zulässige Nachrichtengröße überschreiten.
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
}
Sie können „Big Picture“-Benachrichtigungen senden, indem Sie den Schlüssel appboy_image_url im extra-Objekt angeben. Der Wert für appboy_image_url sollte eine URL sein, die auf den Speicherort Ihres Bildes verweist. Bilder müssen auf ein Seitenverhältnis von 2:1 zugeschnitten werden und sollten mindestens 600 x 300 px groß sein.
Zusätzliche Parameterdetails
| Parameter | Details |
|---|---|
priority |
Dieser Parameter akzeptiert Werte von -2 bis 2, wobei -2 die Priorität „MIN“ und 2 die Priorität „MAX“ darstellt. 0 ist der Standardwert „DEFAULT“. Alle Werte, die außerhalb dieses Bereichs gesendet werden, werden standardmäßig auf 0 gesetzt. Weitere Informationen dazu, welche Prioritätsstufe Sie verwenden sollten, finden Sie unter Android-Benachrichtigungspriorität. |
android_priority |
Dieser Parameter akzeptiert die Werte normal oder high, um die FCM-Senderpriorität festzulegen. Standardmäßig werden Nachrichten mit der auf der Seite Push-Einstellungen konfigurierten Standard-FCM-Priorität gesendet.Weitere Informationen dazu, wie sich verschiedene Werte auf die Zustellung auswirken, finden Sie unter Android-Nachrichtenpriorität. |
collapse_key |
FCM kann pro Gerät gleichzeitig nur bis zu vier Collapse-Keys speichern. Wenn Sie mehr als vier Collapse-Keys verwenden, gibt FCM keine Garantie dafür, welche Keys beibehalten werden. Braze verwendet standardmäßig einen davon für Campaigns. Stellen Sie daher sicher, dass Sie für Android-Nachrichten höchstens drei zusätzliche Collapse-Keys angeben. |
push_icon_image_url |
Der Wert für den Parameter des großen Symbols sollte eine URL sein, die auf den Speicherort Ihres Bildes verweist. Bilder müssen auf ein Seitenverhältnis von 1:1 zugeschnitten werden und sollten mindestens 40 x 40 groß sein. |
notification_channel |
Wenn dies nicht angegeben wird, versucht Braze, die Benachrichtigungs-Payload mit der Dashboard-Fallback-Kanal-ID zu senden. Weitere Informationen finden Sie unter Benachrichtigungskanäle und in den Schritten zum Definieren von Benachrichtigungskanälen während der Integration. |
send_to_sync |
Weitere Informationen zu send_to_sync-Nachrichten finden Sie unter Stille Android-Benachrichtigungen. |
Objekt für Android-Push-Action-Buttons
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
}
Android-Konversations-Push-Objekt
Die Konzepte in dieser Nachricht entsprechen denen in der Push-Dokumentation zu 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)
}
Android-Konversations-Push-Nachrichtenobjekt
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,
}
Android-Konversations-Push-Personenobjekt
1
2
3
4
{
"id" : (required, string) the identifier of this Person,
"name" : (required, string) the display name of this Person
}