TextModuleData

  • Text modules consist of a header and body, with optional localized versions for each.

  • The header and body fields are strings with recommended maximum lengths for display purposes.

  • Localized content can be provided using the localizedHeader and localizedBody fields, which accept LocalizedString objects.

  • Each text module can have a unique id for management and referencing within templates, using only alphanumeric characters, '_', or '-'.

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
header

string

The header of the Text Module. Recommended maximum length is 35 characters to ensure full string is displayed on smaller screens.
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.
localizedHeader

object (LocalizedString)

Translated strings for the header. Recommended maximum length is 35 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.