Conversational Actions were deprecated on June 13, 2023. For more information, see Conversational Actions sunset.

Disclosure

JSON representation
DisclosureText
- JSON representation
TextLink
- JSON representation
DisclosurePresentationOptions
- JSON representation

A product, service or policy disclosure that may be presented to the user.

JSON representation
{ "title": string, "disclosureText": { object (`DisclosureText`) }, "presentationOptions": { object (`DisclosurePresentationOptions`) } }

Fields

Fields
`title`	`string` title of the disclosure. Example: "Safety information".
`disclosureText`	`object (DisclosureText)` Content of the disclosure. Weblinks are allowed.
`presentationOptions`	`object (DisclosurePresentationOptions)` Presentation options for the disclosure.

title

string

title of the disclosure. Example: "Safety information".

disclosureText

object (DisclosureText)

Content of the disclosure. Weblinks are allowed.

presentationOptions

object (DisclosurePresentationOptions)

Presentation options for the disclosure.

DisclosureText

Represents a plain text with web links.

JSON representation
{ "template": string, "textLinks": [ { object (`TextLink`) } ] }

Fields

Fields
`template`	`string` Text to display, containing placeholders like "{0}" and "{1}" for each textlink that should be inserted. Example: "WARNING: This product can expose you to chemicals which are known to the state of California to cause cancer. For more information go to {0}." This disclosure text must not contain any promotional or ad-like content.
`textLinks[]`	`object (TextLink)` Text links that should be substituted into the template. The first one will be substituted for "{0}" in the template string, and the second one for "{1}", etc.

template

string

Text to display, containing placeholders like "{0}" and "{1}" for each textlink that should be inserted. Example: "WARNING: This product can expose you to chemicals which are known to the state of California to cause cancer. For more information go to {0}." This disclosure text must not contain any promotional or ad-like content.

textLinks[]

object (TextLink)

Text links that should be substituted into the template. The first one will be substituted for "{0}" in the template string, and the second one for "{1}", etc.

TextLink

A text link that should be substituted into the template.

JSON representation
{ "displayText": string, "url": string }

Fields

Fields
`displayText`	`string` Text that should be displayed to users.
`url`	`string` URL to which users should be directed when the link is activated.

displayText

string

Text that should be displayed to users.

url

string

URL to which users should be directed when the link is activated.

DisclosurePresentationOptions

Options for the presentation of a disclosure.

JSON representation
{ "presentationRequirement": enum (`PresentationRequirement`), "initiallyExpanded": boolean }

Fields

Fields
`presentationRequirement`	`enum (PresentationRequirement)` Presentation requirement of the disclosure.
`initiallyExpanded`	`boolean` Whether the content of the disclosure should be initially expanded. By default, it is initially collapsed.

presentationRequirement

enum (PresentationRequirement)

Presentation requirement of the disclosure.

initiallyExpanded

boolean

Whether the content of the disclosure should be initially expanded. By default, it is initially collapsed.