Disclosure
Stay organized with collections
Save and categorize content based on your preferences.
A product, service or policy disclosure that may be presented to the user.
| 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.
|
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 |
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.
| 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.
|
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 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eDisclosures provide important product, service, or policy information to users, including titles, detailed text, and presentation options.\u003c/p\u003e\n"],["\u003cp\u003eDisclosure text supports web links using a template with placeholders like "{0}" and "{1}" for dynamic link insertion.\u003c/p\u003e\n"],["\u003cp\u003eText links within disclosures consist of display text and a corresponding URL for user interaction.\u003c/p\u003e\n"],["\u003cp\u003ePresentation options control how disclosures are shown, including whether they are initially expanded or collapsed and the requirement for presentation.\u003c/p\u003e\n"]]],[],null,["# Disclosure\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [DisclosureText](#DisclosureText)\n - [JSON representation](#DisclosureText.SCHEMA_REPRESENTATION)\n- [TextLink](#TextLink)\n - [JSON representation](#TextLink.SCHEMA_REPRESENTATION)\n- [DisclosurePresentationOptions](#DisclosurePresentationOptions)\n - [JSON representation](#DisclosurePresentationOptions.SCHEMA_REPRESENTATION)\n\nA product, service or policy disclosure that may be presented to the user.\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"title\": string, \"disclosureText\": { object (/assistant/df-asdk/reference/webhook/rest/Shared.Types/Disclosure#DisclosureText) }, \"presentationOptions\": { object (/assistant/df-asdk/reference/webhook/rest/Shared.Types/Disclosure#DisclosurePresentationOptions) } } ``` |\n\n| Fields ||\n|-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `title` | `string` title of the disclosure. Example: \"Safety information\". |\n| `disclosureText` | `object (`[DisclosureText](/assistant/df-asdk/reference/webhook/rest/Shared.Types/Disclosure#DisclosureText)`)` Content of the disclosure. Weblinks are allowed. |\n| `presentationOptions` | `object (`[DisclosurePresentationOptions](/assistant/df-asdk/reference/webhook/rest/Shared.Types/Disclosure#DisclosurePresentationOptions)`)` Presentation options for the disclosure. |\n\nDisclosureText\n--------------\n\nRepresents a plain text with web links.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"template\": string, \"textLinks\": [ { object (/assistant/df-asdk/reference/webhook/rest/Shared.Types/Disclosure#TextLink) } ] } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `textLinks[]` | `object (`[TextLink](/assistant/df-asdk/reference/webhook/rest/Shared.Types/Disclosure#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. |\n\nTextLink\n--------\n\nA text link that should be substituted into the template.\n\n| JSON representation ||\n|--------------------------------------------------|---|\n| ``` { \"displayText\": string, \"url\": string } ``` |\n\n| Fields ||\n|---------------|----------------------------------------------------------------------------|\n| `displayText` | `string` Text that should be displayed to users. |\n| `url` | `string` URL to which users should be directed when the link is activated. |\n\nDisclosurePresentationOptions\n-----------------------------\n\nOptions for the presentation of a disclosure.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"presentationRequirement\": enum (/assistant/df-asdk/reference/webhook/rest/Shared.Types/PresentationRequirement), \"initiallyExpanded\": boolean } ``` |\n\n| Fields ||\n|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `presentationRequirement` | `enum (`[PresentationRequirement](/assistant/df-asdk/reference/webhook/rest/Shared.Types/PresentationRequirement)`)` Presentation requirement of the disclosure. |\n| `initiallyExpanded` | `boolean` Whether the content of the disclosure should be initially expanded. By default, it is initially collapsed. |"]]
