Message
Stay organized with collections
Save and categorize content based on your preferences.
A message that will be displayed with a Valuable
| Fields |
kind
(deprecated) |
string
Identifies what kind of resource this is. Value: the fixed string "walletobjects#walletObjectMessage".
|
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.
|
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. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-13 UTC.
[null,null,["Last updated 2025-03-13 UTC."],[[["\u003cp\u003eWallet Object Messages can be displayed to users with valuable content, including a header, body, and display interval.\u003c/p\u003e\n"],["\u003cp\u003eMessages can be customized with localized headers and bodies for different languages.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eMessageType\u003c/code\u003e determines how the message is rendered, with options for text display and Android notifications.\u003c/p\u003e\n"],["\u003cp\u003eEach message has a unique ID for management purposes, and a display interval can be set to control when it is shown.\u003c/p\u003e\n"]]],["The document outlines the structure of a message to be displayed, represented in JSON. Key fields include `header` and `body` for the message content, `displayInterval` to control visibility duration, and `id` for message management. `messageType` specifies how the message is displayed, with options like `TEXT` (default), or `TEXT_AND_NOTIFY`. Localized versions of the `header` and `body` are also supported.\n"],null,["# Message\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [MessageType](#MessageType)\n\nA message that will be displayed with a Valuable\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"header\": string, \"body\": string, \"displayInterval\": { object (/wallet/reference/rest/v1/TimeInterval) }, \"id\": string, \"messageType\": enum (/wallet/reference/rest/v1/Message#MessageType), \"localizedHeader\": { object (/wallet/reference/rest/v1/LocalizedString) }, \"localizedBody\": { object (/wallet/reference/rest/v1/LocalizedString) } } ``` |\n\n| Fields ||\n|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` **(deprecated)** | `string` | This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#walletObjectMessage\"`. |\n| `header` | `string` The message header. |\n| `body` | `string` The message body. |\n| `displayInterval` | `object (`[TimeInterval](/wallet/reference/rest/v1/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. |\n| `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. |\n| `messageType` | `enum (`[MessageType](/wallet/reference/rest/v1/Message#MessageType)`)` The message type. |\n| `localizedHeader` | `object (`[LocalizedString](/wallet/reference/rest/v1/LocalizedString)`)` Translated strings for the message header. |\n| `localizedBody` | `object (`[LocalizedString](/wallet/reference/rest/v1/LocalizedString)`)` Translated strings for the message body. |\n\nMessageType\n-----------\n\n| Enums ||\n|----------------------------|-------------------------------------------------------------------------------------------|\n| `MESSAGE_TYPE_UNSPECIFIED` | |\n| `TEXT` | Renders the message as text on the card details screen. This is the default message type. |\n| `text` | Legacy alias for `TEXT`. Deprecated. | This item is deprecated! |\n| `EXPIRATION_NOTIFICATION` | Note: This enum is currently not supported. |\n| `expirationNotification` | Legacy alias for `EXPIRATION_NOTIFICATION`. Deprecated. | This item is deprecated! |\n| `TEXT_AND_NOTIFY` | Renders the message as text on the card details screen and as an Android notification. |"]]
