Content on this page might refer to the legacy Actions SDK. Refer to the main Conversational Actions documentation for guides and procedures that use Actions Builder and the current Actions SDK.

Disclosure

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

JSON representation
{
  "title": string,
  "disclosureText": {
    object (DisclosureText)
  },
  "presentationOptions": {
    object (DisclosurePresentationOptions)
  }
}
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.

DisclosureText

Represents a plain text with web links.

JSON representation
{
  "template": string,
  "textLinks": [
    {
      object (TextLink)
    }
  ]
}
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.

DisclosurePresentationOptions

Options for the presentation of a disclosure.

JSON representation
{
  "presentationRequirement": enum (PresentationRequirement),
  "initiallyExpanded": boolean
}
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.