TextModuleData
Stay organized with collections
Save and categorize content based on your preferences.
Data for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.
| JSON representation |
{
"header": string,
"body": string,
"localizedHeader": {
object (LocalizedString)
},
"localizedBody": {
object (LocalizedString)
},
"id": string
} |
| Fields |
body |
string
The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
|
localizedBody |
object (LocalizedString)
Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens.
|
id |
string
The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides.
|
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\u003eText modules consist of a header and body, with optional localized versions for each.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eheader\u003c/code\u003e and \u003ccode\u003ebody\u003c/code\u003e fields are strings with recommended maximum lengths for display purposes.\u003c/p\u003e\n"],["\u003cp\u003eLocalized content can be provided using the \u003ccode\u003elocalizedHeader\u003c/code\u003e and \u003ccode\u003elocalizedBody\u003c/code\u003e fields, which accept LocalizedString objects.\u003c/p\u003e\n"],["\u003cp\u003eEach text module can have a unique \u003ccode\u003eid\u003c/code\u003e for management and referencing within templates, using only alphanumeric characters, '_', or '-'.\u003c/p\u003e\n"]]],["The provided data defines the structure of a Text module using a JSON format. Key fields include `header`, `body`, `localizedHeader`, `localizedBody`, and `id`, all optional. Headers and bodies can be defined as strings or localized objects with recommended maximum lengths of 35 and 500 characters, respectively. The `id` field, for management, must be alphanumeric, using '_' or '-' and not '.'. Different body types will be combined, if provided.\n"],null,["# TextModuleData\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nData for Text module. All fields are optional. Header will be displayed if available, different types of bodies will be concatenated if they are defined.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"header\": string, \"body\": string, \"localizedHeader\": { object (/wallet/reference/rest/v1/LocalizedString) }, \"localizedBody\": { object (/wallet/reference/rest/v1/LocalizedString) }, \"id\": string } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `header` | `string` The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. |\n| `body` | `string` The body of the Text Module, which is defined as an uninterrupted string. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. |\n| `localizedHeader` | `object (`[LocalizedString](/wallet/reference/rest/v1/LocalizedString)`)` Translated strings for the header. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens. |\n| `localizedBody` | `object (`[LocalizedString](/wallet/reference/rest/v1/LocalizedString)`)` Translated strings for the body. Recommended maximum length is 500 characters to ensure full string is displayed on smaller screens. |\n| `id` | `string` The ID associated with a text module. This field is here to enable ease of management of text modules and referencing them in template overrides. The ID should only include alphanumeric characters, '_', or '-'. It can not include dots, as dots are used to separate fields within FieldReference.fieldPaths in template overrides. |"]]
