Edit in GitHubLog an issue

Push template - timer

Notification containing title, body, image, and timer.

Alternate title, body, and image can be configured to be shown upon expiry of the timer.

Templates below show all available properties in their respective payloads for FCM (Android) and APNS (iOS).

Properties

The properties below define the payload sent to FCM:

FieldRequiredKeyTypeDescription
Payload Version
✅
adb_version
string
Version of the payload assigned by the ACC authoring UI.
Template Type
✅
adb_template_type
string
Informs the reader which properties may exist in the template object.
Timer template uses a value of "timer".
Title
✅
adb_title
string
Text shown in the notification's title.
Alternate title
✅
adb_title_alt
string
Alternate text for title of the notification after the timer has expired.
Color - Title
⛔️
adb_clr_title
string
Text color for adb_title.
Represented as six character hex, e.g. 00FF00.
Body
✅
adb_body
string
Text shown in message body when notification is collapsed.
Alternate body
⛔️
adb_body_alt
String
Alternate text for body of the notification after the timer has expired.
Expanded Body
⛔️
adb_body_ex
string
Body of the message when the message is expanded.
Alternate expanded body
⛔️
adb_body_ex_alt
string
Alternate text for body of the notification when the message is expanded after the timer has expired.
Color - Body
⛔️
adb_clr_body
string
Text color for adb_body, adb_body_ex.
Represented as six character hex, e.g. 00FF00.
Sound
⛔️
adb_sound
string
Sound played when notification is delivered.
Value should be the name of the sound file without its extension.
Sound file should be located in the assets/raw directory of your app.
Image
⛔️
adb_image
string
URI of an image to be shown when notification is expanded.
Alternate image
⛔️
adb_image_alt
string
Alternate URI of an image to be shown when notification is expanded after the timer has expired.
Link URI
⛔️
adb_uri
string
URI to be handled when user clicks the notification.
Link Type
⛔️
adb_a_type
string
Type of link represented in adb_uri - one of "WEBURL", "DEEPLINK", "DISMISS", or "OPENAPP".
Required if adb_uri is specified.
Icon
⛔️
adb_icon
string
URI or name for Large icon used in notification.
Small Icon
⛔️
adb_small_icon
string
Name of a small icon to use in the notification. The app's drawable resources are checked for an image file with the provided name.
Color - Small Icon
⛔️
adb_clr_icon
string
Color for the notification's small icon.
Represented as six character hex, e.g. 00FF00.
Large Icon
⛔️
adb_large_icon
string
URI or name for a large icon to use in the notification. If the URI is valid, the remote image is downloaded and cached on the device to be used as the large icon. If a name is provided, the app's drawable resources are checked for an image file with the same name. If no valid URI or name is provided then no large icon is set on the notification.
Channel ID
⛔️
adb_channel_id
string
The notification's channel id (new in Android O). The app must create a channel with this channel ID before any notification with this channel ID is received. If you don't send this channel ID in the request, or if the channel ID provided has not yet been created by the app, FCM uses the channel ID specified in the app manifest.
If not provided in payload, SDK uses a "default" channel ID of value "General Notifications".
If < API 26 (Android O), this value is ignored.
Badge Count
⛔️
adb_n_count
string
Value to be used on app's badge.
Priority
⛔️
adb_n_priority
string
Designates the notification priority for Android - importance for API >= 26 (Android 8.0) or priority for API < 26.
Tag
⛔️
adb_tag
string
Identifier used to replace existing notifications in the notification drawer. If not specified, each request creates a new notification. If specified and a notification with the same tag is already being shown, the new notification replaces the existing one in the notification drawer.
Sticky
⛔️
adb_sticky
string
Boolean value represented as a string "true" or "false".
When set to false or unset, the notification is automatically dismissed when the user clicks it in the panel. When set to true, the notification persists even when the user clicks it.
Ticker
⛔️
adb_ticker
string
Sets the "ticker" text, which is sent to accessibility services.
Color - Background
⛔️
adb_clr_bg
string
Color for notification's background.
Represented as six character hex, e.g. 00FF00.
Color - Timer
⛔️
adb_clr_tmr
string
Color for the text of the timer overlay.
Timer duration
⛔️
adb_tmr_dur
string
If present, the timer on the notification will run for the number of seconds provided here.
Timer end timestamp
⛔️
adb_tmr_end
string
If present, the timer on the notification will count down until this epoch time (in seconds).
Note - both adb_tmr_end and adb_tmr_dur are present, the duration will be used and adb_tmr_end will be ignored.

Example

Below is a sample of what a payload might look like for a timer notification:

Copied to your clipboard
{
  "message": {
    "token": "FCM_TOKEN",
    "android": {
      "collapse_key": "new message"
    },
    "data": {     
      "adb_version": "1",
      "adb_title": "Limited time offer!",
      "adb_title_alt": "You missed out on the sale.",
      "adb_body": "Don't miss out on your chance for deep discounts.",
      "adb_body_alt": "Our next flash sale will be sometime next month.",
      "adb_sound": "chaChing",
      "adb_icon": "ic_dollar",
      "adb_n_count": "1",
      "adb_n_priority": "PRIORITY_LOW",
      "adb_image": "https://bigboxretailer.com/sale.png",
      "adb_image_alt": "https://bigboxretailer.com/sale_ended.png",
      "adb_uri": "https://bigboxretailer.com/sale",
      "adb_a_type": "WEBURL",
      "adb_template_type": "timer",
      "adb_body_ex": "These discounts won't be around for long, click on the notification to go check out the sale.",
      "adb_body_ex_alt": "Sorry you missed us this time. Check back next month for some deep discounts.",
      "adb_clr_body": "00EE00",
      "adb_clr_title": "AABBCC",
      "adb_clr_icon": "123456",
      "adb_clr_bg": "000000",
      "adb_tmr_end": "1703462400",
      "adb_clr_tmr": "FFFFFF"
    }
  }
}

Usage recommendations

The tables below contain guidelines for your push notification content. These recommendations help your text and images display reliably across multiple devices. These values are guidelines only - you should still test a notification prior to sending it.

Audio specifications

Custom sound files must be placed within the app's bundle in the res/raw directory. Supported formats are mp3, wav, or ogg.

Image specifications

Aspect ratiosImage size rangeSupported file types
1:1, 3:2, 5:4, 4:3, 2:1, 16:9
< 1 MB
PNG, JPG, WebP

Text guidelines

TypeRecommended max # of charactersSupports multiple lines?
Title
~35 (depends on screen size and device font setting)
No
Description
~110 (depends on screen size and device font setting)
Yes
Steve BenedickRyan Morales
Last updated 8/7/2024
Was this helpful?

Community

Support

Adobe Developer

  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2024 Adobe. All rights reserved.