Message

  • Wallet Object Messages can be displayed to users with valuable content, including a header, body, and display interval.

  • Messages can be customized with localized headers and bodies for different languages.

  • The MessageType determines how the message is rendered, with options for text display and Android notifications.

  • Each message has a unique ID for management purposes, and a display interval can be set to control when it is shown.

A message that will be displayed with a Valuable

JSON representation 
{
  "kind": string,
  "header": string,
  "body": string,
  "displayInterval": {
    object (TimeInterval)
  },
  "id": string,
  "messageType": enum (MessageType),
  "localizedHeader": {
    object (LocalizedString)
  },
  "localizedBody": {
    object (LocalizedString)
  }
}
Fields
kind
(deprecated)

string

Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
header

string

The message header.
body

string

The message body.
displayInterval

object (TimeInterval)

The period of time that the message will be displayed to users. You can define both a startTime and endTime for each message. A message is displayed immediately after a Wallet Object is inserted unless a startTime is set. The message will appear in a list of messages indefinitely if endTime is not provided.
id

string

The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message.
messageType

enum (MessageType)

The message type.
localizedHeader

object (LocalizedString)

Translated strings for the message header.
localizedBody

object (LocalizedString)

Translated strings for the message body.

MessageType

Enums
MESSAGE_TYPE_UNSPECIFIED
TEXT Renders the message as text on the card details screen. This is the default message type.
text

Legacy alias for TEXT. Deprecated.
EXPIRATION_NOTIFICATION Note: This enum is currently not supported.
expirationNotification

Legacy alias for EXPIRATION_NOTIFICATION. Deprecated.
TEXT_AND_NOTIFY Renders the message as text on the card details screen and as an Android notification.