Skip to content

Commit

Permalink
Merge pull request #7282 from braze-inc/BD-3048
Browse files Browse the repository at this point in the history
BD-3048: Fix incorrect link for android pn priority
  • Loading branch information
lydia-xie authored Apr 30, 2024
2 parents a78c252 + 5610233 commit 47d8ab8
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions _docs/_api/objects_filters/messaging/android_object.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: "This reference article lists and explains the different Android ob

> The `android_push` object allows you to define or request information related to Android Push and Android Push Alert content via our [messaging endpoints]({{site.baseurl}}/api/endpoints/messaging).
## Android push object
## Android push object

You must include an Android push object in `messages` if you want users you have targeted to receive a push on their Android devices. The total number of bytes in your `alert` string and `extra` object should not exceed 4,000. The Messaging API will return an error if you exceed the message size allowed by Google.

Expand Down Expand Up @@ -42,11 +42,11 @@ You must include an Android push object in `messages` if you want users you have

You can send "Big Picture" notifications by specifying the key `appboy_image_url` in the `extra` object. The value for `appboy_image_url` should be a URL that links to where your image is hosted. Images need to be cropped to a 2:1 aspect ratio and should be at least 600 x 300 px. Images used for notifications will only display on devices running Jelly Bean (Android 4.1) or higher.

#### Additional parameter details
### Additional parameter details

| Parameter | Details |
| --------- | ------- |
| `priority` | This parameter will accept values from `-2` to `2`, where `-2` represents "MIN" priority and `2` represents "MAX". `0` is the "DEFAULT" value. <br> <br> Any values sent that outside of that integer range will default to 0. For more information on which priority level to use, see our section on [Android notification priority][29]. |
| `priority` | This parameter will accept values from `-2` to `2`, where `-2` represents "MIN" priority and `2` represents "MAX". `0` is the "DEFAULT" value. <br> <br> Any values sent outside of that range will default to 0. For more information on which priority level to use, see [Android notification priority]({{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/customization/advanced_settings#notification-priority). |
| `collapse_key` | FCM can simultaneously store only up to four collapse keys per device. If you use more than four collapse keys, FCM does not make any guarantees as to which ones will be kept. Braze uses one of these by default for campaigns, so make sure to specify only up to three additional collapse keys for Android messages. |
| `push_icon_image_url` | The value for the large icon parameter should be a URL that links to where your image is hosted. <br> <br> Images need to be cropped to a 1:1 aspect ratio and should be at least 40x40. |
| `notification_channel` | If this is not specified, Braze will attempt to send the notification payload with the [dashboard fallback][45] channel ID. For more, see [Notification channels][44] and refer to the steps for [defining notification channels][43] during integration. |
Expand Down Expand Up @@ -99,7 +99,6 @@ The concepts in this message correspond to those in the [Android People and Conv
```

[28]: {{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/android/silent_push_notifications/#silent-push-notifications
[29]: {{site.baseurl}}/developer_guide/platform_integration_guides/android/advanced_use_cases/deep_linking/
[44]: {{site.baseurl}}/user_guide/message_building_by_channel/push/notification_channels/
[43]: {{site.baseurl}}/developer_guide/platform_integration_guides/android/push_notifications/integration/standard_integration/#step-5-define-notification-channels
[45]: {{site.baseurl}}/user_guide/message_building_by_channel/push/android/notification_channels/#dashboard-fallback-channel
Expand Down

0 comments on commit 47d8ab8

Please sign in to comment.