From dd56bd7c1810c19d22cd4efe55c0e11674f384ee Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 23 Sep 2025 07:09:06 +0000 Subject: [PATCH 01/26] feat(aiplatform): update the api #### aiplatform:v1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1EvaluationRunMetric.properties.computationBasedMetricSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec (Total Keys: 5) - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources.properties.flagContentUri.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution (Total Keys: 5) - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.authorAttribution.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.flagContentUri.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.review.type (Total Keys: 1) The following keys were added: - resources.projects.resources.locations.resources.endpoints.resources.deployedModels.resources.invoke.methods.invoke (Total Keys: 18) - resources.projects.resources.locations.resources.endpoints.resources.invoke.methods.invoke (Total Keys: 15) - resources.projects.resources.locations.resources.endpoints.resources.openapi.methods.embeddings (Total Keys: 14) - schemas.GoogleCloudAiplatformV1DeployRequestEndpointConfig.properties.privateServiceConnectConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GoogleMaps.properties.enableWidget.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.reviewId.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.sourceFlaggingUris (Total Keys: 3) - schemas.GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri (Total Keys: 4) - schemas.GoogleCloudAiplatformV1InvokeRequest (Total Keys: 4) - schemas.GoogleCloudAiplatformV1LLMBasedMetricSpec (Total Keys: 10) - schemas.GoogleCloudAiplatformV1Metric.properties.llmBasedMetricSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1Tool.properties.googleSearchRetrieval.deprecated (Total Keys: 1) The following keys were changed: - endpoints (Total Keys: 1) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1EvaluationRunMetric.properties.computationBasedMetricSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunMetricComputationBasedMetricSpec (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources.properties.flagContentUri.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.authorAttribution.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.flagContentUri.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.review.type (Total Keys: 1) The following keys were added: - resources.projects.resources.locations.resources.endpoints.resources.deployedModels.resources.invoke.methods.invoke (Total Keys: 18) - resources.projects.resources.locations.resources.endpoints.resources.invoke.methods.invoke (Total Keys: 15) - resources.projects.resources.locations.resources.endpoints.resources.openapi.methods.embeddings (Total Keys: 14) - resources.projects.resources.locations.resources.reasoningEngines.resources.a2a.resources.v1.methods.card (Total Keys: 18) - resources.projects.resources.locations.resources.reasoningEngines.resources.a2a.resources.v1.resources.message.methods.send (Total Keys: 18) - resources.projects.resources.locations.resources.reasoningEngines.resources.a2a.resources.v1.resources.message.methods.stream (Total Keys: 17) - resources.projects.resources.locations.resources.reasoningEngines.resources.a2a.resources.v1.resources.tasks.methods.a2aGetReasoningEngine (Total Keys: 18) - resources.projects.resources.locations.resources.reasoningEngines.resources.a2a.resources.v1.resources.tasks.methods.cancel (Total Keys: 18) - resources.projects.resources.locations.resources.reasoningEngines.resources.a2a.resources.v1.resources.tasks.methods.pushNotificationConfigs (Total Keys: 18) - resources.projects.resources.locations.resources.reasoningEngines.resources.a2a.resources.v1.resources.tasks.methods.subscribe (Total Keys: 15) - resources.projects.resources.locations.resources.reasoningEngines.resources.a2a.resources.v1.resources.tasks.resources.pushNotificationConfigs.methods.a2aGetReasoningEngine (Total Keys: 18) - resources.projects.resources.publishers.resources.models.methods.enableModel (Total Keys: 16) - resources.reasoningEngines.resources.a2a.resources.v1.methods.card (Total Keys: 18) - resources.reasoningEngines.resources.a2a.resources.v1.resources.message.methods.send (Total Keys: 18) - resources.reasoningEngines.resources.a2a.resources.v1.resources.message.methods.stream (Total Keys: 17) - resources.reasoningEngines.resources.a2a.resources.v1.resources.tasks.methods.a2aGetReasoningEngine (Total Keys: 18) - resources.reasoningEngines.resources.a2a.resources.v1.resources.tasks.methods.cancel (Total Keys: 18) - resources.reasoningEngines.resources.a2a.resources.v1.resources.tasks.methods.pushNotificationConfigs (Total Keys: 18) - resources.reasoningEngines.resources.a2a.resources.v1.resources.tasks.methods.subscribe (Total Keys: 15) - resources.reasoningEngines.resources.a2a.resources.v1.resources.tasks.resources.pushNotificationConfigs.methods.a2aGetReasoningEngine (Total Keys: 18) - schemas.GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig.properties.privateServiceConnectConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EnableModelRequest (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1EnableModelResponse (Total Keys: 6) - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.modelConfig.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GoogleMaps.properties.enableWidget.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet.properties.reviewId.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.sourceFlaggingUris (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1InvokeRequest (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1LLMBasedMetricSpec (Total Keys: 10) - schemas.GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleGeneratedMemory.properties.topics (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1MemoryTopicId (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1Metric.properties.llmBasedMetricSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1Tool.properties.googleSearchRetrieval.deprecated (Total Keys: 1) The following keys were changed: - endpoints (Total Keys: 1) --- docs/dyn/aiplatform_v1.endpoints.html | 119 +- ..._v1.projects.locations.cachedContents.html | 18 +- ...ts.locations.endpoints.deployedModels.html | 91 + ...tions.endpoints.deployedModels.invoke.html | 132 ++ ...tform_v1.projects.locations.endpoints.html | 134 +- ...1.projects.locations.endpoints.invoke.html | 131 ++ ....projects.locations.endpoints.openapi.html | 128 ++ ..._v1.projects.locations.evaluationRuns.html | 24 - .../dyn/aiplatform_v1.projects.locations.html | 83 +- ....projects.locations.publishers.models.html | 119 +- docs/dyn/aiplatform_v1.publishers.models.html | 119 +- docs/dyn/aiplatform_v1beta1.endpoints.html | 119 +- docs/dyn/aiplatform_v1beta1.projects.html | 5 + ...ta1.projects.locations.cachedContents.html | 18 +- ...m_v1beta1.projects.locations.datasets.html | 6 +- ...ts.locations.endpoints.deployedModels.html | 91 + ...tions.endpoints.deployedModels.invoke.html | 132 ++ ..._v1beta1.projects.locations.endpoints.html | 134 +- ...1.projects.locations.endpoints.invoke.html | 131 ++ ....projects.locations.endpoints.openapi.html | 128 ++ ...ta1.projects.locations.evaluationRuns.html | 24 - ...aiplatform_v1beta1.projects.locations.html | 84 +- ....projects.locations.publishers.models.html | 119 +- ...ojects.locations.reasoningEngines.a2a.html | 91 + ...cts.locations.reasoningEngines.a2a.v1.html | 120 ++ ...tions.reasoningEngines.a2a.v1.message.html | 140 ++ ...cations.reasoningEngines.a2a.v1.tasks.html | 168 ++ ....a2a.v1.tasks.pushNotificationConfigs.html | 110 ++ ...1.projects.locations.reasoningEngines.html | 29 + ...ions.reasoningEngines.sessions.events.html | 23 +- ...s.locations.reasoningEngines.sessions.html | 23 +- ...v1beta1.projects.locations.tuningJobs.html | 310 ++++ ...iplatform_v1beta1.projects.publishers.html | 91 + ...rm_v1beta1.projects.publishers.models.html | 117 ++ .../aiplatform_v1beta1.publishers.models.html | 119 +- ...platform_v1beta1.reasoningEngines.a2a.html | 91 + ...tform_v1beta1.reasoningEngines.a2a.v1.html | 120 ++ ...beta1.reasoningEngines.a2a.v1.message.html | 140 ++ ...v1beta1.reasoningEngines.a2a.v1.tasks.html | 168 ++ ....a2a.v1.tasks.pushNotificationConfigs.html | 110 ++ .../aiplatform_v1beta1.reasoningEngines.html | 29 + ...eta1.reasoningEngines.sessions.events.html | 23 +- ...orm_v1beta1.reasoningEngines.sessions.html | 23 +- .../documents/aiplatform.v1.json | 366 ++-- .../documents/aiplatform.v1beta1.json | 1623 +++++++++++++---- 45 files changed, 5117 insertions(+), 1006 deletions(-) create mode 100644 docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.invoke.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.endpoints.invoke.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.deployedModels.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.deployedModels.invoke.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.invoke.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.openapi.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.message.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.tasks.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.publishers.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.publishers.models.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.message.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.tasks.html create mode 100644 docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.html diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index 27c29ce8d2a..07021899ba8 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -479,13 +479,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -952,13 +953,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1134,25 +1136,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1197,6 +1192,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1245,10 +1246,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -1261,38 +1262,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } @@ -1688,13 +1689,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1870,25 +1872,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1933,6 +1928,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1981,10 +1982,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -1997,38 +1998,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index 1a343de469a..41d0c92487d 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -322,13 +322,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -652,13 +653,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1007,13 +1009,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1348,13 +1351,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1697,13 +1701,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2028,13 +2033,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.html new file mode 100644 index 00000000000..0a9efff18e8 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . projects . locations . endpoints . deployedModels

+

Instance Methods

+

+ invoke() +

+

Returns the invoke Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.invoke.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.invoke.html new file mode 100644 index 00000000000..e395e04b7fe --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.deployedModels.invoke.html @@ -0,0 +1,132 @@ + + + +

Vertex AI API . projects . locations . endpoints . deployedModels . invoke

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ invoke(endpoint, deployedModelId, invokeId, body=None, x__xgafv=None)

+

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ invoke(endpoint, deployedModelId, invokeId, body=None, x__xgafv=None) + 
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  deployedModelId: string, ID of the DeployedModel that serves the invoke request. (required)
+  invokeId: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PredictionService.Invoke.
+  "deployedModelId": "A String", # ID of the DeployedModel that serves the invoke request.
+  "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The invoke method input. Supports HTTP headers and arbitrary data payload.
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index edcfb1cb078..a74c9f3d33e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -79,6 +79,21 @@

Instance Methods

Returns the chat Resource.

+

+ deployedModels() +

+

Returns the deployedModels Resource.

+ +

+ invoke() +

+

Returns the invoke Resource.

+ +

+ openapi() +

+

Returns the openapi Resource.

+

operations()

@@ -532,13 +547,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1899,13 +1915,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2081,25 +2098,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -2144,6 +2154,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -2192,10 +2208,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -2208,38 +2224,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } @@ -4112,13 +4128,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -4294,25 +4311,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -4357,6 +4367,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -4405,10 +4421,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -4421,38 +4437,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.invoke.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.invoke.html new file mode 100644 index 00000000000..6f0fcfbb473 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.invoke.html @@ -0,0 +1,131 @@ + + + +

Vertex AI API . projects . locations . endpoints . invoke

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ invoke(endpoint, invokeId, body=None, x__xgafv=None)

+

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ invoke(endpoint, invokeId, body=None, x__xgafv=None) + 
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  invokeId: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PredictionService.Invoke.
+  "deployedModelId": "A String", # ID of the DeployedModel that serves the invoke request.
+  "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The invoke method input. Supports HTTP headers and arbitrary data payload.
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html new file mode 100644 index 00000000000..afb90446424 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.openapi.html @@ -0,0 +1,128 @@ + + + +

Vertex AI API . projects . locations . endpoints . openapi

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ embeddings(endpoint, body=None, deployedModelId=None, x__xgafv=None)

+

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ embeddings(endpoint, body=None, deployedModelId=None, x__xgafv=None) + 
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  deployedModelId: string, ID of the DeployedModel that serves the invoke request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index 0be2d2ff604..5dc12113c63 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -252,12 +252,6 @@

Method Details

}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. @@ -1006,12 +1000,6 @@

Method Details

}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. @@ -1802,12 +1790,6 @@

Method Details

}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. @@ -2569,12 +2551,6 @@

Method Details

}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index e1324fb929f..417a3f081b9 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -616,10 +616,27 @@

Method Details

}, }, "endpointConfig": { # The endpoint config to use for the deployment. # Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used. - "dedicatedEndpointDisabled": True or False, # Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com. + "dedicatedEndpointDisabled": True or False, # Optional. By default, if dedicated endpoint is enabled and private service connect config is not set, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is set, the endpoint will be exposed through private service connect. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com. "dedicatedEndpointEnabled": True or False, # Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. "endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used. "endpointUserId": "A String", # Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. + "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect. + "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. + "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. + "A String", + ], + "pscAutomationConfigs": [ # Optional. List of projects and networks where the PSC endpoints will be created. This field is used by Online Inference(Prediction) only. + { # PSC config that is used to automatically create PSC endpoints in the user projects. + "errorMessage": "A String", # Output only. Error message if the PSC service automation failed. + "forwardingRule": "A String", # Output only. Forwarding rule created by the PSC service automation. + "ipAddress": "A String", # Output only. IP address rule created by the PSC service automation. + "network": "A String", # Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/get): `projects/{project}/global/networks/{network}`. + "projectId": "A String", # Required. Project id used to create forwarding rule. + "state": "A String", # Output only. The state of the PSC service automation. + }, + ], + "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. + }, }, "huggingFaceModelId": "A String", # The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`. "modelConfig": { # The model config to use for the deployment. # Optional. The model config to use for the deployment. If not specified, the default model config will be used. @@ -822,6 +839,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -1211,6 +1259,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -2247,7 +2326,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index ca388308b3a..cc1f5193187 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -483,13 +483,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -956,13 +957,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1138,25 +1140,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1201,6 +1196,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1249,10 +1250,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -1265,38 +1266,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } @@ -1920,13 +1921,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2102,25 +2104,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -2165,6 +2160,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -2213,10 +2214,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -2229,38 +2230,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 1e15a8b18c9..b9cf3732bea 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -477,13 +477,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -950,13 +951,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1132,25 +1134,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1195,6 +1190,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1243,10 +1244,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -1259,38 +1260,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } @@ -2259,13 +2260,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2441,25 +2443,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -2504,6 +2499,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -2552,10 +2553,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -2568,38 +2569,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index d6931876260..fbe32bf7e44 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -488,13 +488,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -975,13 +976,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1166,25 +1168,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1232,6 +1227,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1280,10 +1281,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -1296,38 +1297,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } @@ -1730,13 +1731,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1921,25 +1923,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1987,6 +1982,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -2035,10 +2036,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -2051,38 +2052,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } diff --git a/docs/dyn/aiplatform_v1beta1.projects.html b/docs/dyn/aiplatform_v1beta1.projects.html index 738f00355a6..870e3689440 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.html +++ b/docs/dyn/aiplatform_v1beta1.projects.html @@ -84,6 +84,11 @@

Instance Methods

Returns the modelGardenEula Resource.

+

+ publishers() +

+

Returns the publishers Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 406c76c1560..162ba524d31 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -326,13 +326,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -667,13 +668,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1033,13 +1035,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1385,13 +1388,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1745,13 +1749,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2087,13 +2092,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index 21bd4c5b7bf..91d39d25867 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -460,13 +460,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -927,13 +928,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.deployedModels.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.deployedModels.html new file mode 100644 index 00000000000..7ec98e323dc --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.deployedModels.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . projects . locations . endpoints . deployedModels

+

Instance Methods

+

+ invoke() +

+

Returns the invoke Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.deployedModels.invoke.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.deployedModels.invoke.html new file mode 100644 index 00000000000..9b39effc6fc --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.deployedModels.invoke.html @@ -0,0 +1,132 @@ + + + +

Vertex AI API . projects . locations . endpoints . deployedModels . invoke

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ invoke(endpoint, deployedModelId, invokeId, body=None, x__xgafv=None)

+

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ invoke(endpoint, deployedModelId, invokeId, body=None, x__xgafv=None) + 
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  deployedModelId: string, ID of the DeployedModel that serves the invoke request. (required)
+  invokeId: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PredictionService.Invoke.
+  "deployedModelId": "A String", # ID of the DeployedModel that serves the invoke request.
+  "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The invoke method input. Supports HTTP headers and arbitrary data payload.
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 30b81327ec3..141cd06bde1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -79,6 +79,21 @@

Instance Methods

Returns the chat Resource.

+

+ deployedModels() +

+

Returns the deployedModels Resource.

+ +

+ invoke() +

+

Returns the invoke Resource.

+ +

+ openapi() +

+

Returns the openapi Resource.

+

operations()

@@ -550,13 +565,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2106,13 +2122,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2297,25 +2314,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -2363,6 +2373,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -2411,10 +2427,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -2427,38 +2443,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } @@ -4552,13 +4568,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -4743,25 +4760,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -4809,6 +4819,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -4857,10 +4873,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -4873,38 +4889,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.invoke.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.invoke.html new file mode 100644 index 00000000000..a80f9091bfa --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.invoke.html @@ -0,0 +1,131 @@ + + + +

Vertex AI API . projects . locations . endpoints . invoke

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ invoke(endpoint, invokeId, body=None, x__xgafv=None)

+

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ invoke(endpoint, invokeId, body=None, x__xgafv=None) + 
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  invokeId: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for PredictionService.Invoke.
+  "deployedModelId": "A String", # ID of the DeployedModel that serves the invoke request.
+  "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The invoke method input. Supports HTTP headers and arbitrary data payload.
+    "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+    "data": "A String", # The HTTP request/response body as raw binary.
+    "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.openapi.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.openapi.html new file mode 100644 index 00000000000..3da2404eaad --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.openapi.html @@ -0,0 +1,128 @@ + + + +

Vertex AI API . projects . locations . endpoints . openapi

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ embeddings(endpoint, body=None, deployedModelId=None, x__xgafv=None)

+

Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ embeddings(endpoint, body=None, deployedModelId=None, x__xgafv=None) + 
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+  endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+  deployedModelId: string, ID of the DeployedModel that serves the invoke request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 13b10f60307..6d74a5fa9e2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -260,12 +260,6 @@

Method Details

}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. @@ -1035,12 +1029,6 @@

Method Details

}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. @@ -1852,12 +1840,6 @@

Method Details

}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. @@ -2640,12 +2622,6 @@

Method Details

}, "metrics": [ # Required. The metrics to be calculated in the evaluation run. { # The metric used for evaluation runs. - "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. - "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}. - "a_key": "", # Properties of the object. - }, - "type": "A String", # Required. The type of the computation based metric. - }, "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. "additionalConfig": { # Optional. Optional additional configuration for the metric. "a_key": "", # Properties of the object. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index c22dfe7cea9..f4d09264925 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -692,10 +692,28 @@

Method Details

}, }, "endpointConfig": { # The endpoint config to use for the deployment. # Optional. The endpoint config to use for the deployment. If not specified, the default endpoint config will be used. - "dedicatedEndpointDisabled": True or False, # Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com. + "dedicatedEndpointDisabled": True or False, # Optional. By default, if dedicated endpoint is enabled and private service connect config is not set, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is set, the endpoint will be exposed through private service connect. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com. "dedicatedEndpointEnabled": True or False, # Optional. Deprecated. Use dedicated_endpoint_disabled instead. If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. "endpointDisplayName": "A String", # Optional. The user-specified display name of the endpoint. If not set, a default name will be used. "endpointUserId": "A String", # Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. + "privateServiceConnectConfig": { # Represents configuration for private service connect. # Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect. + "enablePrivateServiceConnect": True or False, # Required. If true, expose the IndexEndpoint via private service connect. + "enableSecurePrivateServiceConnect": True or False, # Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled. + "projectAllowlist": [ # A list of Projects from which the forwarding rule will target the service attachment. + "A String", + ], + "pscAutomationConfigs": [ # Optional. List of projects and networks where the PSC endpoints will be created. This field is used by Online Inference(Prediction) only. + { # PSC config that is used to automatically create PSC endpoints in the user projects. + "errorMessage": "A String", # Output only. Error message if the PSC service automation failed. + "forwardingRule": "A String", # Output only. Forwarding rule created by the PSC service automation. + "ipAddress": "A String", # Output only. IP address rule created by the PSC service automation. + "network": "A String", # Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/get): `projects/{project}/global/networks/{network}`. + "projectId": "A String", # Required. Project id used to create forwarding rule. + "state": "A String", # Output only. The state of the PSC service automation. + }, + ], + "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. + }, }, "huggingFaceModelId": "A String", # The Hugging Face model to deploy. Format: Hugging Face model ID like `google/gemma-2-2b-it`. "modelConfig": { # The model config to use for the deployment. # Optional. The model config to use for the deployment. If not specified, the default model config will be used. @@ -977,6 +995,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -1374,6 +1423,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -2422,7 +2502,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 1de9ad88a44..aa2bf6cceb7 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -504,13 +504,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1063,13 +1064,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1254,25 +1256,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1320,6 +1315,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1368,10 +1369,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -1384,38 +1385,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } @@ -2133,13 +2134,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -2324,25 +2326,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -2390,6 +2385,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -2438,10 +2439,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -2454,38 +2455,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.html new file mode 100644 index 00000000000..03768274b24 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . a2a

+

Instance Methods

+

+ v1() +

+

Returns the v1 Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.html new file mode 100644 index 00000000000..5212cf6b058 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.html @@ -0,0 +1,120 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . a2a . v1

+

Instance Methods

+

+ message() +

+

Returns the message Resource.

+ +

+ tasks() +

+

Returns the tasks Resource.

+ +

+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None) + 
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.message.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.message.html new file mode 100644 index 00000000000..b36b6175052 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.message.html @@ -0,0 +1,140 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . a2a . v1 . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ stream(name, a2aEndpoint, body=None, x__xgafv=None)

+

Streams queries using a reasoning engine instance via the A2A streaming protocol apis.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ send(name, a2aEndpoint, body=None, x__xgafv=None) + 
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ stream(name, a2aEndpoint, body=None, x__xgafv=None) + 
Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. e.g., v1/message:stream. (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.tasks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.tasks.html new file mode 100644 index 00000000000..63a52218e3b --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.tasks.html @@ -0,0 +1,168 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . a2a . v1 . tasks

+

Instance Methods

+

+ pushNotificationConfigs() +

+

Returns the pushNotificationConfigs Resource.

+ +

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ cancel(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ close()

+

Close httplib2 connections.

+

+ subscribe(name, a2aEndpoint, x__xgafv=None)

+

Stream get request for reasoning engine instance via the A2A stream get protocol apis.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) + 
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ cancel(name, a2aEndpoint, body=None, x__xgafv=None) + 
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ subscribe(name, a2aEndpoint, x__xgafv=None) + 
Stream get request for reasoning engine instance via the A2A stream get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.html new file mode 100644 index 00000000000..f392c4b0876 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.html @@ -0,0 +1,110 @@ + + + +

Vertex AI API . projects . locations . reasoningEngines . a2a . v1 . tasks . pushNotificationConfigs

+

Instance Methods

+

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) + 
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index fc80c1fba26..2c9fea0b692 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -74,6 +74,11 @@

Vertex AI API . projects . locations . reasoningEngines

Instance Methods

+

+ a2a() +

+

Returns the a2a Resource.

+

examples()

@@ -204,6 +209,12 @@

Method Details

"generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. "fact": "A String", # Required. The fact to generate a memory from. + "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], }, ], }, @@ -445,6 +456,12 @@

Method Details

"generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. "fact": "A String", # Required. The fact to generate a memory from. + "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], }, ], }, @@ -628,6 +645,12 @@

Method Details

"generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. "fact": "A String", # Required. The fact to generate a memory from. + "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], }, ], }, @@ -816,6 +839,12 @@

Method Details

"generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. "fact": "A String", # Required. The fact to generate a memory from. + "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], }, ], }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html index 80f48158e06..f27925ffdb3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -186,25 +186,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -252,6 +245,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index 705f0449a1d..4c5b68174ef 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -195,25 +195,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -261,6 +254,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 5af15df7597..760753ac9ff 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -277,6 +277,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -344,6 +375,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -967,6 +1029,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -1034,6 +1127,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -1664,6 +1788,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -1731,6 +1886,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -2367,6 +2553,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -2434,6 +2651,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -3203,6 +3451,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. @@ -3270,6 +3549,37 @@

Method Details

}, "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric. }, + "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric. + "additionalConfig": { # Optional. Optional additional configuration for the metric. + "a_key": "", # Properties of the object. + }, + "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater). + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model. + "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec. + "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1". + "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric. + "a_key": "", # Properties of the object. + }, + }, + "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification. + "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation. + "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` + "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias. + "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. + }, + "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements. + "rubricContentType": "A String", # The type of rubric content to be generated. + "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology. + "A String", + ], + }, + "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance. + "systemInstruction": "A String", # Optional. System instructions for the judge model. + }, "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric. "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response. "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response. diff --git a/docs/dyn/aiplatform_v1beta1.projects.publishers.html b/docs/dyn/aiplatform_v1beta1.projects.publishers.html new file mode 100644 index 00000000000..f1a8a9d2d62 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.publishers.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . projects . publishers

+

Instance Methods

+

+ models() +

+

Returns the models Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.publishers.models.html new file mode 100644 index 00000000000..7d10176210a --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.publishers.models.html @@ -0,0 +1,117 @@ + + + +

Vertex AI API . projects . publishers . models

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ enableModel(parent, name, body=None, x__xgafv=None)

+

Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ enableModel(parent, name, body=None, x__xgafv=None) + 
Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).
+
+Args:
+  parent: string, Required. The project requesting access for named model. Format: `projects/{project}` (required)
+  name: string, Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ModelGardenService.EnableModel.
+  "service": "A String", # Optional. The ID links the Marketplace listing to the underlying Vertex AI model endpoint. Format: `services/{service_id}` Format: `services/{service_id}`
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ModelGardenService.EnableModel.
+  "enablementState": "A String", # Output only. The result of the model enablement.
+  "publisherEndpoint": "A String", # Output only. The publisher endpoint that the project is enabled for. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{publisher_model}`
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index ef6cdd40df8..c7c6871c460 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -492,13 +492,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -979,13 +980,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -1170,25 +1172,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -1236,6 +1231,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -1284,10 +1285,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -1300,38 +1301,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } @@ -2953,13 +2954,14 @@

Method Details

}, ], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. If true, include the widget context token in the response. }, "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. "A String", ], }, - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. @@ -3144,25 +3146,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -3210,6 +3205,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], @@ -3258,10 +3259,10 @@

Method Details

], "createTime": "A String", # Output only. Timestamp when the request is made to the server. "modelVersion": "A String", # Output only. The model version used to generate the response. - "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. - "blockReason": "A String", # Output only. Blocked reason. - "blockReasonMessage": "A String", # Output only. A readable block reason message. - "safetyRatings": [ # Output only. Safety ratings. + "promptFeedback": { # Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. + "blockReason": "A String", # Output only. The reason why the prompt was blocked. + "blockReasonMessage": "A String", # Output only. A readable message that explains the reason why the prompt was blocked. + "safetyRatings": [ # Output only. A list of safety ratings for the prompt. There is one rating per category. { # Safety rating corresponding to the generated content. "blocked": True or False, # Output only. Indicates whether the content was filtered out because of this rating. "category": "A String", # Output only. Harm category. @@ -3274,38 +3275,38 @@

Method Details

], }, "responseId": "A String", # Output only. response_id is used to identify each response. It is the encoding of the event_id. - "usageMetadata": { # Usage metadata about response(s). # Usage metadata about the response(s). - "cacheTokensDetails": [ # Output only. List of modalities of the cached content in the request input. + "usageMetadata": { # Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics. # Usage metadata about the response(s). + "cacheTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the cached content. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "cachedContentTokenCount": 42, # Output only. Number of tokens in the cached part in the input (the cached content). - "candidatesTokenCount": 42, # Number of tokens in the response(s). - "candidatesTokensDetails": [ # Output only. List of modalities that were returned in the response. + "cachedContentTokenCount": 42, # Output only. The number of tokens in the cached content that was used for this request. + "candidatesTokenCount": 42, # The total number of tokens in the generated candidates. + "candidatesTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the generated candidates. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "promptTokenCount": 42, # Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. - "promptTokensDetails": [ # Output only. List of modalities that were processed in the request input. + "promptTokenCount": 42, # The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content. + "promptTokensDetails": [ # Output only. A detailed breakdown of the token count for each modality in the prompt. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "thoughtsTokenCount": 42, # Output only. Number of tokens present in thoughts output. - "toolUsePromptTokenCount": 42, # Output only. Number of tokens present in tool-use prompt(s). - "toolUsePromptTokensDetails": [ # Output only. List of modalities that were processed for tool-use request inputs. + "thoughtsTokenCount": 42, # Output only. The number of tokens that were part of the model's generated "thoughts" output, if applicable. + "toolUsePromptTokenCount": 42, # Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable. + "toolUsePromptTokensDetails": [ # Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input. { # Represents token counting info for a single modality. "modality": "A String", # The modality associated with this token count. "tokenCount": 42, # Number of tokens. }, ], - "totalTokenCount": 42, # Total token count for prompt, response candidates, and tool-use prompts (if present). - "trafficType": "A String", # Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota. + "totalTokenCount": 42, # The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`. + "trafficType": "A String", # Output only. The traffic type for this request. }, } diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.html new file mode 100644 index 00000000000..c2bef3c4ad0 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.html @@ -0,0 +1,91 @@ + + + +

Vertex AI API . reasoningEngines . a2a

+

Instance Methods

+

+ v1() +

+

Returns the v1 Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.html new file mode 100644 index 00000000000..466f3b3a7f2 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.html @@ -0,0 +1,120 @@ + + + +

Vertex AI API . reasoningEngines . a2a . v1

+

Instance Methods

+

+ message() +

+

Returns the message Resource.

+ +

+ tasks() +

+

Returns the tasks Resource.

+ +

+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ card(name, a2aEndpoint, historyLength=None, x__xgafv=None) + 
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.message.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.message.html new file mode 100644 index 00000000000..811a5671ec9 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.message.html @@ -0,0 +1,140 @@ + + + +

Vertex AI API . reasoningEngines . a2a . v1 . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ stream(name, a2aEndpoint, body=None, x__xgafv=None)

+

Streams queries using a reasoning engine instance via the A2A streaming protocol apis.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ send(name, a2aEndpoint, body=None, x__xgafv=None) + 
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ stream(name, a2aEndpoint, body=None, x__xgafv=None) + 
Streams queries using a reasoning engine instance via the A2A streaming protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. e.g., v1/message:stream. (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.tasks.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.tasks.html new file mode 100644 index 00000000000..f5625e17fad --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.tasks.html @@ -0,0 +1,168 @@ + + + +

Vertex AI API . reasoningEngines . a2a . v1 . tasks

+

Instance Methods

+

+ pushNotificationConfigs() +

+

Returns the pushNotificationConfigs Resource.

+ +

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ cancel(name, a2aEndpoint, body=None, x__xgafv=None)

+

Send post request for reasoning engine instance via the A2A post protocol apis.

+

+ close()

+

Close httplib2 connections.

+

+ subscribe(name, a2aEndpoint, x__xgafv=None)

+

Stream get request for reasoning engine instance via the A2A stream get protocol apis.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) + 
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ cancel(name, a2aEndpoint, body=None, x__xgafv=None) + 
Send post request for reasoning engine instance via the A2A post protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send (required)
+  body: object, The request body.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ +
+ subscribe(name, a2aEndpoint, x__xgafv=None) + 
Stream get request for reasoning engine instance via the A2A stream get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.html new file mode 100644 index 00000000000..4e31730b1a1 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.html @@ -0,0 +1,110 @@ + + + +

Vertex AI API . reasoningEngines . a2a . v1 . tasks . pushNotificationConfigs

+

Instance Methods

+

+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None)

+

Get request for reasoning engine instance via the A2A get protocol apis.

+

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ a2aGetReasoningEngine(name, a2aEndpoint, historyLength=None, x__xgafv=None) + 
Get request for reasoning engine instance via the A2A get protocol apis.
+
+Args:
+  name: string, Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
+  a2aEndpoint: string, Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123` (required)
+  historyLength: string, Optional. The optional query parameter for the getTask endpoint. Mapped from "?history_length=". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "a_key": "", # Properties of the object.
+}
+
+ +
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index 75fead300de..b02cbd9d166 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -74,6 +74,11 @@

Vertex AI API . reasoningEngines

Instance Methods

+

+ a2a() +

+

Returns the a2a Resource.

+

memories()

@@ -188,6 +193,12 @@

Method Details

"generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. "fact": "A String", # Required. The fact to generate a memory from. + "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], }, ], }, @@ -430,6 +441,12 @@

Method Details

"generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. "fact": "A String", # Required. The fact to generate a memory from. + "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], }, ], }, @@ -613,6 +630,12 @@

Method Details

"generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. "fact": "A String", # Required. The fact to generate a memory from. + "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], }, ], }, @@ -801,6 +824,12 @@

Method Details

"generatedMemories": [ # Optional. The memories that are expected to be generated from the input conversation. An empty list indicates that no memories are expected to be generated for the input conversation. { # A memory generated by the operation. "fact": "A String", # Required. The fact to generate a memory from. + "topics": [ # Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = "jargon"` if the extracted memory is an example of memory extraction for the custom topic `jargon`. + { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval. + "customMemoryTopicLabel": "A String", # Optional. The custom memory topic label. + "managedMemoryTopic": "A String", # Optional. The managed memory topic. + }, + ], }, ], }, diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index 1acecf1a02d..645e765fb13 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -186,25 +186,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -252,6 +245,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index f166cff0607..96bf335ba10 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -190,25 +190,18 @@

Method Details

{ # Grounding chunk. "maps": { # Chunk from Google Maps. # Grounding chunk from Google Maps. "placeAnswerSources": { # Sources used to generate the place answer. # Sources used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as uris to flag content. - "flagContentUri": "A String", # A link where users can flag a problem with the generated answer. "reviewSnippets": [ # Snippets of reviews that are used to generate the answer. { # Encapsulates a review snippet. - "authorAttribution": { # Author attribution for a photo or review. # This review's author. - "displayName": "A String", # Name of the author of the Photo or Review. - "photoUri": "A String", # Profile photo URI of the author of the Photo or Review. - "uri": "A String", # URI of the author of the Photo or Review. - }, - "flagContentUri": "A String", # A link where users can flag a problem with the review. "googleMapsUri": "A String", # A link to show the review on Google Maps. - "relativePublishTimeDescription": "A String", # A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country. - "review": "A String", # A reference representing this place review which may be used to look up this place review again. + "reviewId": "A String", # Id of the review referencing the place. + "title": "A String", # Title of the review. }, ], }, "placeId": "A String", # This Place's resource name, in `places/{place_id}` format. Can be used to look up the Place. - "text": "A String", # Text of the chunk. - "title": "A String", # Title of the chunk. - "uri": "A String", # URI reference of the chunk. + "text": "A String", # Text of the place answer. + "title": "A String", # Title of the place. + "uri": "A String", # URI reference of the place. }, "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. "documentName": "A String", # Output only. The full document name for the referenced Vertex AI Search document. @@ -256,6 +249,12 @@

Method Details

"renderedContent": "A String", # Optional. Web content snippet that can be embedded in a web page or an app webview. "sdkBlob": "A String", # Optional. Base64 encoded JSON representing array of tuple. }, + "sourceFlaggingUris": [ # Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding. + { # Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding. + "flagContentUri": "A String", # A link where users can flag a problem with the source (place or review). + "sourceId": "A String", # Id of the place or review. + }, + ], "webSearchQueries": [ # Optional. Web search queries for the following-up web search. "A String", ], diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 743e6bbb8cc..ed764a29a04 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -228,6 +228,16 @@ "description": "Locational Endpoint", "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", "location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://aiplatform.us.rep.googleapis.com/", +"location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", +"location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1382,7 +1392,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -4969,6 +4979,133 @@ } } }, +"deployedModels": { +"resources": { +"invoke": { +"methods": { +"invoke": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", +"parameterOrder": [ +"endpoint", +"deployedModelId", +"invokeId" +], +"parameters": { +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"location": "path", +"required": true, +"type": "string" +}, +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +}, +"invokeId": { +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", +"request": { +"$ref": "GoogleCloudAiplatformV1InvokeRequest" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} +} +} +}, +"invoke": { +"methods": { +"invoke": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.endpoints.invoke.invoke", +"parameterOrder": [ +"endpoint", +"invokeId" +], +"parameters": { +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +}, +"invokeId": { +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}/invoke/{+invokeId}", +"request": { +"$ref": "GoogleCloudAiplatformV1InvokeRequest" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} +}, +"openapi": { +"methods": { +"embeddings": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.endpoints.openapi.embeddings", +"parameterOrder": [ +"endpoint" +], +"parameters": { +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"location": "query", +"type": "string" +}, +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+endpoint}/embeddings", +"request": { +"$ref": "GoogleApiHttpBody" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" +] +} +} +}, "operations": { "methods": { "cancel": { @@ -20793,7 +20930,7 @@ } } }, -"revision": "20250902", +"revision": "20250916", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -25092,7 +25229,7 @@ "id": "GoogleCloudAiplatformV1DeployRequestEndpointConfig", "properties": { "dedicatedEndpointDisabled": { -"description": "Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.", +"description": "Optional. By default, if dedicated endpoint is enabled and private service connect config is not set, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is set, the endpoint will be exposed through private service connect. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.", "type": "boolean" }, "dedicatedEndpointEnabled": { @@ -25107,6 +25244,10 @@ "endpointUserId": { "description": "Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.", "type": "string" +}, +"privateServiceConnectConfig": { +"$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", +"description": "Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect." } }, "type": "object" @@ -26814,10 +26955,6 @@ "description": "The metric used for evaluation runs.", "id": "GoogleCloudAiplatformV1EvaluationRunMetric", "properties": { -"computationBasedMetricSpec": { -"$ref": "GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec", -"description": "Spec for a computation based metric." -}, "llmBasedMetricSpec": { "$ref": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec", "description": "Spec for an LLM based metric." @@ -26837,37 +26974,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec": { -"description": "Specification for a computation based metric.", -"id": "GoogleCloudAiplatformV1EvaluationRunMetricComputationBasedMetricSpec", -"properties": { -"parameters": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "Optional. A map of parameters for the metric, e.g. {\"rouge_type\": \"rougeL\"}.", -"type": "object" -}, -"type": { -"description": "Required. The type of the computation based metric.", -"enum": [ -"COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED", -"EXACT_MATCH", -"BLEU", -"ROUGE" -], -"enumDescriptions": [ -"Unspecified computation based metric type.", -"Exact match metric.", -"BLEU metric.", -"ROUGE metric." -], -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec": { "description": "Specification for an LLM based metric.", "id": "GoogleCloudAiplatformV1EvaluationRunMetricLLMBasedMetricSpec", @@ -30064,11 +30170,11 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback": { -"description": "Content filter results for a prompt sent in the request.", +"description": "Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations.", "id": "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback", "properties": { "blockReason": { -"description": "Output only. Blocked reason.", +"description": "Output only. The reason why the prompt was blocked.", "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", @@ -30079,24 +30185,24 @@ "IMAGE_SAFETY" ], "enumDescriptions": [ -"Unspecified blocked reason.", -"Candidates blocked due to safety.", -"Candidates blocked due to other reason.", -"Candidates blocked due to the terms which are included from the terminology blocklist.", -"Candidates blocked due to prohibited content.", -"The user prompt was blocked by Model Armor.", -"Candidates blocked due to unsafe image generation content." +"The blocked reason is unspecified.", +"The prompt was blocked for safety reasons.", +"The prompt was blocked for other reasons. For example, it may be due to the prompt's language, or because it contains other harmful content.", +"The prompt was blocked because it contains a term from the terminology blocklist.", +"The prompt was blocked because it contains prohibited content.", +"The prompt was blocked by Model Armor.", +"The prompt was blocked because it contains content that is unsafe for image generation." ], "readOnly": true, "type": "string" }, "blockReasonMessage": { -"description": "Output only. A readable block reason message.", +"description": "Output only. A readable message that explains the reason why the prompt was blocked.", "readOnly": true, "type": "string" }, "safetyRatings": { -"description": "Output only. Safety ratings.", +"description": "Output only. A list of safety ratings for the prompt. There is one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1SafetyRating" }, @@ -30107,11 +30213,11 @@ "type": "object" }, "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata": { -"description": "Usage metadata about response(s).", +"description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", "id": "GoogleCloudAiplatformV1GenerateContentResponseUsageMetadata", "properties": { "cacheTokensDetails": { -"description": "Output only. List of modalities of the cached content in the request input.", +"description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", "items": { "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" }, @@ -30119,18 +30225,18 @@ "type": "array" }, "cachedContentTokenCount": { -"description": "Output only. Number of tokens in the cached part in the input (the cached content).", +"description": "Output only. The number of tokens in the cached content that was used for this request.", "format": "int32", "readOnly": true, "type": "integer" }, "candidatesTokenCount": { -"description": "Number of tokens in the response(s).", +"description": "The total number of tokens in the generated candidates.", "format": "int32", "type": "integer" }, "candidatesTokensDetails": { -"description": "Output only. List of modalities that were returned in the response.", +"description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", "items": { "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" }, @@ -30138,12 +30244,12 @@ "type": "array" }, "promptTokenCount": { -"description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", +"description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, "promptTokensDetails": { -"description": "Output only. List of modalities that were processed in the request input.", +"description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", "items": { "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" }, @@ -30151,19 +30257,19 @@ "type": "array" }, "thoughtsTokenCount": { -"description": "Output only. Number of tokens present in thoughts output.", +"description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokenCount": { -"description": "Output only. Number of tokens present in tool-use prompt(s).", +"description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokensDetails": { -"description": "Output only. List of modalities that were processed for tool-use request inputs.", +"description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.", "items": { "$ref": "GoogleCloudAiplatformV1ModalityTokenCount" }, @@ -30171,12 +30277,12 @@ "type": "array" }, "totalTokenCount": { -"description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", +"description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.", "format": "int32", "type": "integer" }, "trafficType": { -"description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.", +"description": "Output only. The traffic type for this request.", "enum": [ "TRAFFIC_TYPE_UNSPECIFIED", "ON_DEMAND", @@ -30184,7 +30290,7 @@ ], "enumDescriptions": [ "Unspecified request traffic type.", -"Type for Pay-As-You-Go traffic.", +"The request was processed using Pay-As-You-Go quota.", "Type for Provisioned Throughput traffic." ], "readOnly": true, @@ -30602,7 +30708,12 @@ "GoogleCloudAiplatformV1GoogleMaps": { "description": "Tool to retrieve public maps data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1GoogleMaps", -"properties": {}, +"properties": { +"enableWidget": { +"description": "Optional. If true, include the widget context token in the response.", +"type": "boolean" +} +}, "type": "object" }, "GoogleCloudAiplatformV1GoogleSearchRetrieval": { @@ -30714,15 +30825,15 @@ "type": "string" }, "text": { -"description": "Text of the chunk.", +"description": "Text of the place answer.", "type": "string" }, "title": { -"description": "Title of the chunk.", +"description": "Title of the place.", "type": "string" }, "uri": { -"description": "URI reference of the chunk.", +"description": "URI reference of the place.", "type": "string" } }, @@ -30732,10 +30843,6 @@ "description": "Sources used to generate the place answer.", "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSources", "properties": { -"flagContentUri": { -"description": "A link where users can flag a problem with the generated answer.", -"type": "string" -}, "reviewSnippets": { "description": "Snippets of reviews that are used to generate the answer.", "items": { @@ -30746,47 +30853,20 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution": { -"description": "Author attribution for a photo or review.", -"id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", -"properties": { -"displayName": { -"description": "Name of the author of the Photo or Review.", -"type": "string" -}, -"photoUri": { -"description": "Profile photo URI of the author of the Photo or Review.", -"type": "string" -}, -"uri": { -"description": "URI of the author of the Photo or Review.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { "description": "Encapsulates a review snippet.", "id": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { -"authorAttribution": { -"$ref": "GoogleCloudAiplatformV1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", -"description": "This review's author." -}, -"flagContentUri": { -"description": "A link where users can flag a problem with the review.", -"type": "string" -}, "googleMapsUri": { "description": "A link to show the review on Google Maps.", "type": "string" }, -"relativePublishTimeDescription": { -"description": "A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.", +"reviewId": { +"description": "Id of the review referencing the place.", "type": "string" }, -"review": { -"description": "A reference representing this place review which may be used to look up this place review again.", +"title": { +"description": "Title of the review.", "type": "string" } }, @@ -30871,6 +30951,14 @@ "$ref": "GoogleCloudAiplatformV1SearchEntryPoint", "description": "Optional. Google search entry for the following-up web searches." }, +"sourceFlaggingUris": { +"description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", +"items": { +"$ref": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri" +}, +"readOnly": true, +"type": "array" +}, "webSearchQueries": { "description": "Optional. Web search queries for the following-up web search.", "items": { @@ -30881,6 +30969,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri": { +"description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", +"id": "GoogleCloudAiplatformV1GroundingMetadataSourceFlaggingUri", +"properties": { +"flagContentUri": { +"description": "A link where users can flag a problem with the source (place or review).", +"type": "string" +}, +"sourceId": { +"description": "Id of the place or review.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1GroundingSupport": { "description": "Grounding support.", "id": "GoogleCloudAiplatformV1GroundingSupport", @@ -31808,6 +31911,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1InvokeRequest": { +"description": "Request message for PredictionService.Invoke.", +"id": "GoogleCloudAiplatformV1InvokeRequest", +"properties": { +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"type": "string" +}, +"httpBody": { +"$ref": "GoogleApiHttpBody", +"description": "The invoke method input. Supports HTTP headers and arbitrary data payload." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1JiraSource": { "description": "The Jira source for the ImportRagFilesRequest.", "id": "GoogleCloudAiplatformV1JiraSource", @@ -31855,6 +31973,45 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1LLMBasedMetricSpec": { +"description": "Specification for an LLM based metric.", +"id": "GoogleCloudAiplatformV1LLMBasedMetricSpec", +"properties": { +"additionalConfig": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Optional additional configuration for the metric.", +"type": "object" +}, +"judgeAutoraterConfig": { +"$ref": "GoogleCloudAiplatformV1AutoraterConfig", +"description": "Optional. Optional configuration for the judge LLM (Autorater)." +}, +"metricPromptTemplate": { +"description": "Required. Template for the prompt sent to the judge model.", +"type": "string" +}, +"predefinedRubricGenerationSpec": { +"$ref": "GoogleCloudAiplatformV1PredefinedMetricSpec", +"description": "Dynamically generate rubrics using a predefined spec." +}, +"rubricGenerationSpec": { +"$ref": "GoogleCloudAiplatformV1RubricGenerationSpec", +"description": "Dynamically generate rubrics using this specification." +}, +"rubricGroupKey": { +"description": "Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.", +"type": "string" +}, +"systemInstruction": { +"description": "Optional. System instructions for the judge model.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1LargeModelReference": { "description": "Contains information about the Large Model.", "id": "GoogleCloudAiplatformV1LargeModelReference", @@ -33284,6 +33441,10 @@ false "$ref": "GoogleCloudAiplatformV1ExactMatchSpec", "description": "Spec for exact match metric." }, +"llmBasedMetricSpec": { +"$ref": "GoogleCloudAiplatformV1LLMBasedMetricSpec", +"description": "Spec for an LLM based metric." +}, "pairwiseMetricSpec": { "$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec", "description": "Spec for pairwise metric." @@ -47636,7 +47797,8 @@ false }, "googleSearchRetrieval": { "$ref": "GoogleCloudAiplatformV1GoogleSearchRetrieval", -"description": "Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search." +"deprecated": true, +"description": "Optional. Specialized retrieval tool that is powered by Google Search." }, "retrieval": { "$ref": "GoogleCloudAiplatformV1Retrieval", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index ebba728d36c..8fb059bc1cc 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -228,6 +228,16 @@ "description": "Locational Endpoint", "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", "location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://aiplatform.us.rep.googleapis.com/", +"location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", +"location": "eu" } ], "fullyEncodeReservedExpansion": true, @@ -1465,7 +1475,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -5687,294 +5697,165 @@ } } }, -"operations": { +"deployedModels": { +"resources": { +"invoke": { "methods": { -"cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel", +"invoke": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/deployedModels/{deployedModelId}/invoke/{invokeId}", "httpMethod": "POST", -"id": "aiplatform.projects.locations.endpoints.operations.cancel", +"id": "aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke", "parameterOrder": [ -"name" +"endpoint", +"deployedModelId", +"invokeId" ], "parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1beta1/{+name}:cancel", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.endpoints.operations.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be deleted.", +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.endpoints.operations.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource.", +"invokeId": { "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}", +"path": "v1beta1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] +} +} +} +} }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.endpoints.operations.list", +"invoke": { +"methods": { +"invoke": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/invoke/{invokeId}", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.endpoints.invoke.invoke", "parameterOrder": [ -"name" +"endpoint", +"invokeId" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", "required": true, "type": "string" }, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+name}/operations", -"response": { -"$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.endpoints.operations.wait", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to wait on.", +"invokeId": { "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+name}:wait", +"path": "v1beta1/{+endpoint}/invoke/{+invokeId}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1InvokeRequest" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] } } -} -} }, -"evaluationItems": { +"openapi": { "methods": { -"create": { -"description": "Creates an Evaluation Item.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", +"embeddings": { +"description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/openapi/embeddings", "httpMethod": "POST", -"id": "aiplatform.projects.locations.evaluationItems.create", +"id": "aiplatform.projects.locations.endpoints.openapi.embeddings", "parameterOrder": [ -"parent" +"endpoint" ], "parameters": { -"parent": { -"description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"location": "query", +"type": "string" +}, +"endpoint": { +"description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/openapi$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/evaluationItems", +"path": "v1beta1/{+endpoint}/embeddings", "request": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" +"$ref": "GoogleApiHttpBody" }, "response": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" +"$ref": "GoogleApiHttpBody" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only" ] -}, -"delete": { -"description": "Deletes an Evaluation Item.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.evaluationItems.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", -"required": true, -"type": "string" +} } }, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets an Evaluation Item.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.evaluationItems.get", +"operations": { +"methods": { +"cancel": { +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.endpoints.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists Evaluation Items.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.evaluationItems.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The maximum number of Evaluation Items to return.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", +"description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/evaluationItems", +"path": "v1beta1/{+name}:cancel", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"operations": { -"methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.evaluationItems.operations.delete", +"id": "aiplatform.projects.locations.endpoints.operations.delete", "parameterOrder": [ "name" ], @@ -5982,7 +5863,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5997,9 +5878,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.evaluationItems.operations.get", +"id": "aiplatform.projects.locations.endpoints.operations.get", "parameterOrder": [ "name" ], @@ -6007,7 +5888,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6022,9 +5903,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.evaluationItems.operations.list", +"id": "aiplatform.projects.locations.endpoints.operations.list", "parameterOrder": [ "name" ], @@ -6037,7 +5918,263 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpoints/{endpointsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.endpoints.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpoints/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"evaluationItems": { +"methods": { +"create": { +"description": "Creates an Evaluation Item.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.evaluationItems.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/evaluationItems", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes an Evaluation Item.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.evaluationItems.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an Evaluation Item.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationItems.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationItem" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Evaluation Items.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationItems.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of Evaluation Items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/evaluationItems", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListEvaluationItemsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"delete": { +"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.evaluationItems.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationItems.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationItems/{evaluationItemsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationItems.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationItems/[^/]+$", "required": true, "type": "string" }, @@ -19995,6 +20132,359 @@ } }, "resources": { +"a2a": { +"resources": { +"v1": { +"methods": { +"card": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.card", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/card$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"message": { +"methods": { +"send": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.send", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^v1/message$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"stream": { +"description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.message.stream", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", +"location": "path", +"pattern": "^v1/message$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"tasks": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"cancel": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.cancel", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"pushNotificationConfigs": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"subscribe": { +"description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.subscribe", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"pushNotificationConfigs": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +}, "examples": { "resources": { "operations": { @@ -25020,6 +25510,50 @@ ] } } +}, +"publishers": { +"resources": { +"models": { +"methods": { +"enableModel": { +"description": "Enables model for the project if prerequisites are met (e.g. completed questionnaire and consents, or an active Private Offer).", +"flatPath": "v1beta1/projects/{projectsId}/publishers/{publishersId}/models/{modelsId}:enableModel", +"httpMethod": "POST", +"id": "aiplatform.projects.publishers.models.enableModel", +"parameterOrder": [ +"parent", +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}`", +"location": "path", +"pattern": "^publishers/[^/]+/models/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Required. The project requesting access for named model. Format: `projects/{project}`", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/{+name}:enableModel", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1EnableModelRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1EnableModelResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} } } }, @@ -25578,6 +26112,359 @@ } }, "resources": { +"a2a": { +"resources": { +"v1": { +"methods": { +"card": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/card", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.card", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/card$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"message": { +"methods": { +"send": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:send", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.a2a.v1.message.send", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^v1/message$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:send", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"stream": { +"description": "Streams queries using a reasoning engine instance via the A2A streaming protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/message:stream", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.a2a.v1.message.stream", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. e.g., v1/message:stream.", +"location": "path", +"pattern": "^v1/message$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:stream", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"tasks": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks.a2aGetReasoningEngine", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"cancel": { +"description": "Send post request for reasoning engine instance via the A2A post protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks.cancel", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The a2a endpoint path, captured from the URL. e.g., v1/message:send", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:cancel", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"pushNotificationConfigs": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"subscribe": { +"description": "Stream get request for reasoning engine instance via the A2A stream get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}:subscribe", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks.subscribe", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123:subscribe`.", +"location": "path", +"pattern": "^v1/tasks/[^/]+$", +"required": true, +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL.", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}:subscribe", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"pushNotificationConfigs": { +"methods": { +"a2aGetReasoningEngine": { +"description": "Get request for reasoning engine instance via the A2A get protocol apis.", +"flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/a2a/v1/tasks/{tasksId}/pushNotificationConfigs/{pushNotificationConfigsId}", +"httpMethod": "GET", +"id": "aiplatform.reasoningEngines.a2a.v1.tasks.pushNotificationConfigs.a2aGetReasoningEngine", +"parameterOrder": [ +"name", +"a2aEndpoint" +], +"parameters": { +"a2aEndpoint": { +"description": "Required. The http endpoint extracted from the URL path. i.e. `v1/tasks/123`", +"location": "path", +"pattern": "^v1/tasks/[^/]+/pushNotificationConfigs/[^/]+$", +"required": true, +"type": "string" +}, +"historyLength": { +"description": "Optional. The optional query parameter for the getTask endpoint. Mapped from \"?history_length=\". This indicates how many turns of history to return. If not set, the default value is 0, which means all the history will be returned.", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. The full resource path of the reasoning engine, captured from the URL. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", +"location": "path", +"pattern": "^reasoningEngines/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}/a2a/{+a2aEndpoint}", +"response": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +}, "memories": { "methods": { "create": { @@ -26036,7 +26923,7 @@ } } }, -"revision": "20250902", +"revision": "20250916", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -30898,7 +31785,7 @@ "id": "GoogleCloudAiplatformV1beta1DeployRequestEndpointConfig", "properties": { "dedicatedEndpointDisabled": { -"description": "Optional. By default, if dedicated endpoint is enabled, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.", +"description": "Optional. By default, if dedicated endpoint is enabled and private service connect config is not set, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. If private service connect config is set, the endpoint will be exposed through private service connect. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitations will be removed soon. If this field is set to true, the dedicated endpoint will be disabled and the deployed model will be exposed through the shared DNS {region}-aiplatform.googleapis.com.", "type": "boolean" }, "dedicatedEndpointEnabled": { @@ -30913,6 +31800,10 @@ "endpointUserId": { "description": "Optional. Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body.", "type": "string" +}, +"privateServiceConnectConfig": { +"$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", +"description": "Optional. Configuration for private service connect. If set, the endpoint will be exposed through private service connect." } }, "type": "object" @@ -31533,6 +32424,44 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1EnableModelRequest": { +"description": "Request message for ModelGardenService.EnableModel.", +"id": "GoogleCloudAiplatformV1beta1EnableModelRequest", +"properties": { +"service": { +"description": "Optional. The ID links the Marketplace listing to the underlying Vertex AI model endpoint. Format: `services/{service_id}` Format: `services/{service_id}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1EnableModelResponse": { +"description": "Response message for ModelGardenService.EnableModel.", +"id": "GoogleCloudAiplatformV1beta1EnableModelResponse", +"properties": { +"enablementState": { +"description": "Output only. The result of the model enablement.", +"enum": [ +"ENABLEMENT_STATE_UNSPECIFIED", +"ENABLEMENT_STATE_SUCCEEDED", +"ENABLEMENT_STATE_FAILED" +], +"enumDescriptions": [ +"The PublisherModel enable status is unclear. The API will default to this value.", +"The PublisherModel is enabled successfully.", +"The PublisherModel is failed to enable" +], +"readOnly": true, +"type": "string" +}, +"publisherEndpoint": { +"description": "Output only. The publisher endpoint that the project is enabled for. Format: `projects/{project}/locations/{location}/publishers/{publisher}/models/{publisher_model}`", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1EncryptionSpec": { "description": "Represents a customer-managed encryption key spec that can be applied to a top-level resource.", "id": "GoogleCloudAiplatformV1beta1EncryptionSpec", @@ -32772,10 +33701,6 @@ "description": "The metric used for evaluation runs.", "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetric", "properties": { -"computationBasedMetricSpec": { -"$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricComputationBasedMetricSpec", -"description": "Spec for a computation based metric." -}, "llmBasedMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunMetricLLMBasedMetricSpec", "description": "Spec for an LLM based metric." @@ -32795,37 +33720,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1EvaluationRunMetricComputationBasedMetricSpec": { -"description": "Specification for a computation based metric.", -"id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricComputationBasedMetricSpec", -"properties": { -"parameters": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "Optional. A map of parameters for the metric, e.g. {\"rouge_type\": \"rougeL\"}.", -"type": "object" -}, -"type": { -"description": "Required. The type of the computation based metric.", -"enum": [ -"COMPUTATION_BASED_METRIC_TYPE_UNSPECIFIED", -"EXACT_MATCH", -"BLEU", -"ROUGE" -], -"enumDescriptions": [ -"Unspecified computation based metric type.", -"Exact match metric.", -"BLEU metric.", -"ROUGE metric." -], -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1EvaluationRunMetricLLMBasedMetricSpec": { "description": "Specification for an LLM based metric.", "id": "GoogleCloudAiplatformV1beta1EvaluationRunMetricLLMBasedMetricSpec", @@ -36650,7 +37544,7 @@ "Default model behavior, model decides to predict either function calls or natural language response.", "Model is constrained to always predicting function calls only. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\".", "Model will not predict any function calls. Model behavior is same as when not passing any function declarations.", -"Model is constrained to predict either function calls or natural language response." +"Model is constrained to predict either function calls or natural language response. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\"." ], "type": "string" } @@ -37025,11 +37919,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback": { -"description": "Content filter results for a prompt sent in the request.", +"description": "Content filter results for a prompt sent in the request. Note: This is sent only in the first stream chunk and only if no candidates were generated due to content violations.", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback", "properties": { "blockReason": { -"description": "Output only. Blocked reason.", +"description": "Output only. The reason why the prompt was blocked.", "enum": [ "BLOCKED_REASON_UNSPECIFIED", "SAFETY", @@ -37040,24 +37934,24 @@ "IMAGE_SAFETY" ], "enumDescriptions": [ -"Unspecified blocked reason.", -"Candidates blocked due to safety.", -"Candidates blocked due to other reason.", -"Candidates blocked due to the terms which are included from the terminology blocklist.", -"Candidates blocked due to prohibited content.", -"The user prompt was blocked by Model Armor.", -"Candidates blocked due to unsafe image generation content." +"The blocked reason is unspecified.", +"The prompt was blocked for safety reasons.", +"The prompt was blocked for other reasons. For example, it may be due to the prompt's language, or because it contains other harmful content.", +"The prompt was blocked because it contains a term from the terminology blocklist.", +"The prompt was blocked because it contains prohibited content.", +"The prompt was blocked by Model Armor.", +"The prompt was blocked because it contains content that is unsafe for image generation." ], "readOnly": true, "type": "string" }, "blockReasonMessage": { -"description": "Output only. A readable block reason message.", +"description": "Output only. A readable message that explains the reason why the prompt was blocked.", "readOnly": true, "type": "string" }, "safetyRatings": { -"description": "Output only. Safety ratings.", +"description": "Output only. A list of safety ratings for the prompt. There is one rating per category.", "items": { "$ref": "GoogleCloudAiplatformV1beta1SafetyRating" }, @@ -37068,11 +37962,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata": { -"description": "Usage metadata about response(s).", +"description": "Usage metadata about the content generation request and response. This message provides a detailed breakdown of token usage and other relevant metrics.", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "properties": { "cacheTokensDetails": { -"description": "Output only. List of modalities of the cached content in the request input.", +"description": "Output only. A detailed breakdown of the token count for each modality in the cached content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -37080,18 +37974,18 @@ "type": "array" }, "cachedContentTokenCount": { -"description": "Output only. Number of tokens in the cached part in the input (the cached content).", +"description": "Output only. The number of tokens in the cached content that was used for this request.", "format": "int32", "readOnly": true, "type": "integer" }, "candidatesTokenCount": { -"description": "Number of tokens in the response(s).", +"description": "The total number of tokens in the generated candidates.", "format": "int32", "type": "integer" }, "candidatesTokensDetails": { -"description": "Output only. List of modalities that were returned in the response.", +"description": "Output only. A detailed breakdown of the token count for each modality in the generated candidates.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -37099,12 +37993,12 @@ "type": "array" }, "promptTokenCount": { -"description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", +"description": "The total number of tokens in the prompt. This includes any text, images, or other media provided in the request. When `cached_content` is set, this also includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, "promptTokensDetails": { -"description": "Output only. List of modalities that were processed in the request input.", +"description": "Output only. A detailed breakdown of the token count for each modality in the prompt.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -37112,19 +38006,19 @@ "type": "array" }, "thoughtsTokenCount": { -"description": "Output only. Number of tokens present in thoughts output.", +"description": "Output only. The number of tokens that were part of the model's generated \"thoughts\" output, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokenCount": { -"description": "Output only. Number of tokens present in tool-use prompt(s).", +"description": "Output only. The number of tokens in the results from tool executions, which are provided back to the model as input, if applicable.", "format": "int32", "readOnly": true, "type": "integer" }, "toolUsePromptTokensDetails": { -"description": "Output only. List of modalities that were processed for tool-use request inputs.", +"description": "Output only. A detailed breakdown by modality of the token counts from the results of tool executions, which are provided back to the model as input.", "items": { "$ref": "GoogleCloudAiplatformV1beta1ModalityTokenCount" }, @@ -37132,12 +38026,12 @@ "type": "array" }, "totalTokenCount": { -"description": "Total token count for prompt, response candidates, and tool-use prompts (if present).", +"description": "The total number of tokens for the entire request. This is the sum of `prompt_token_count`, `candidates_token_count`, `tool_use_prompt_token_count`, and `thoughts_token_count`.", "format": "int32", "type": "integer" }, "trafficType": { -"description": "Output only. Traffic type. This shows whether a request consumes Pay-As-You-Go or Provisioned Throughput quota.", +"description": "Output only. The traffic type for this request.", "enum": [ "TRAFFIC_TYPE_UNSPECIFIED", "ON_DEMAND", @@ -37145,7 +38039,7 @@ ], "enumDescriptions": [ "Unspecified request traffic type.", -"Type for Pay-As-You-Go traffic.", +"The request was processed using Pay-As-You-Go quota.", "Type for Provisioned Throughput traffic." ], "readOnly": true, @@ -37439,6 +38333,7 @@ }, "modelConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigModelConfig", +"deprecated": true, "description": "Optional. Config for model selection." }, "presencePenalty": { @@ -37691,7 +38586,12 @@ "GoogleCloudAiplatformV1beta1GoogleMaps": { "description": "Tool to retrieve public maps data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleMaps", -"properties": {}, +"properties": { +"enableWidget": { +"description": "Optional. If true, include the widget context token in the response.", +"type": "boolean" +} +}, "type": "object" }, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { @@ -37803,15 +38703,15 @@ "type": "string" }, "text": { -"description": "Text of the chunk.", +"description": "Text of the place answer.", "type": "string" }, "title": { -"description": "Title of the chunk.", +"description": "Title of the place.", "type": "string" }, "uri": { -"description": "URI reference of the chunk.", +"description": "URI reference of the place.", "type": "string" } }, @@ -37821,10 +38721,6 @@ "description": "Sources used to generate the place answer.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources", "properties": { -"flagContentUri": { -"description": "A link where users can flag a problem with the generated answer.", -"type": "string" -}, "reviewSnippets": { "description": "Snippets of reviews that are used to generate the answer.", "items": { @@ -37835,47 +38731,20 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution": { -"description": "Author attribution for a photo or review.", -"id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", -"properties": { -"displayName": { -"description": "Name of the author of the Photo or Review.", -"type": "string" -}, -"photoUri": { -"description": "Profile photo URI of the author of the Photo or Review.", -"type": "string" -}, -"uri": { -"description": "URI of the author of the Photo or Review.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet": { "description": "Encapsulates a review snippet.", "id": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet", "properties": { -"authorAttribution": { -"$ref": "GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesAuthorAttribution", -"description": "This review's author." -}, -"flagContentUri": { -"description": "A link where users can flag a problem with the review.", -"type": "string" -}, "googleMapsUri": { "description": "A link to show the review on Google Maps.", "type": "string" }, -"relativePublishTimeDescription": { -"description": "A string of formatted recent time, expressing the review time relative to the current time in a form appropriate for the language and country.", +"reviewId": { +"description": "Id of the review referencing the place.", "type": "string" }, -"review": { -"description": "A reference representing this place review which may be used to look up this place review again.", +"title": { +"description": "Title of the review.", "type": "string" } }, @@ -37967,6 +38836,14 @@ "$ref": "GoogleCloudAiplatformV1beta1SearchEntryPoint", "description": "Optional. Google search entry for the following-up web searches." }, +"sourceFlaggingUris": { +"description": "Optional. Output only. List of source flagging uris. This is currently populated only for Google Maps grounding.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri" +}, +"readOnly": true, +"type": "array" +}, "webSearchQueries": { "description": "Optional. Web search queries for the following-up web search.", "items": { @@ -37977,6 +38854,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri": { +"description": "Source content flagging uri for a place or review. This is currently populated only for Google Maps grounding.", +"id": "GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri", +"properties": { +"flagContentUri": { +"description": "A link where users can flag a problem with the source (place or review).", +"type": "string" +}, +"sourceId": { +"description": "Id of the place or review.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GroundingSupport": { "description": "Grounding support.", "id": "GoogleCloudAiplatformV1beta1GroundingSupport", @@ -39115,6 +40007,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1InvokeRequest": { +"description": "Request message for PredictionService.Invoke.", +"id": "GoogleCloudAiplatformV1beta1InvokeRequest", +"properties": { +"deployedModelId": { +"description": "ID of the DeployedModel that serves the invoke request.", +"type": "string" +}, +"httpBody": { +"$ref": "GoogleApiHttpBody", +"description": "The invoke method input. Supports HTTP headers and arbitrary data payload." +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1JiraSource": { "description": "The Jira source for the ImportRagFilesRequest.", "id": "GoogleCloudAiplatformV1beta1JiraSource", @@ -39162,6 +40069,45 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1LLMBasedMetricSpec": { +"description": "Specification for an LLM based metric.", +"id": "GoogleCloudAiplatformV1beta1LLMBasedMetricSpec", +"properties": { +"additionalConfig": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Optional additional configuration for the metric.", +"type": "object" +}, +"judgeAutoraterConfig": { +"$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", +"description": "Optional. Optional configuration for the judge LLM (Autorater)." +}, +"metricPromptTemplate": { +"description": "Required. Template for the prompt sent to the judge model.", +"type": "string" +}, +"predefinedRubricGenerationSpec": { +"$ref": "GoogleCloudAiplatformV1beta1PredefinedMetricSpec", +"description": "Dynamically generate rubrics using a predefined spec." +}, +"rubricGenerationSpec": { +"$ref": "GoogleCloudAiplatformV1beta1RubricGenerationSpec", +"description": "Dynamically generate rubrics using this specification." +}, +"rubricGroupKey": { +"description": "Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.", +"type": "string" +}, +"systemInstruction": { +"description": "Optional. System instructions for the judge model.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1LargeModelReference": { "description": "Contains information about the Large Model.", "id": "GoogleCloudAiplatformV1beta1LargeModelReference", @@ -40759,6 +41705,13 @@ false "fact": { "description": "Required. The fact to generate a memory from.", "type": "string" +}, +"topics": { +"description": "Optional. The list of topics that the memory should be associated with. For example, use `custom_memory_topic_label = \"jargon\"` if the extracted memory is an example of memory extraction for the custom topic `jargon`.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryTopicId" +}, +"type": "array" } }, "type": "object" @@ -40818,6 +41771,35 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1MemoryTopicId": { +"description": "A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.", +"id": "GoogleCloudAiplatformV1beta1MemoryTopicId", +"properties": { +"customMemoryTopicLabel": { +"description": "Optional. The custom memory topic label.", +"type": "string" +}, +"managedMemoryTopic": { +"description": "Optional. The managed memory topic.", +"enum": [ +"MANAGED_TOPIC_ENUM_UNSPECIFIED", +"USER_PERSONAL_INFO", +"USER_PREFERENCES", +"KEY_CONVERSATION_DETAILS", +"EXPLICIT_INSTRUCTIONS" +], +"enumDescriptions": [ +"Unspecified topic. This value should not be used.", +"Significant personal information about the User like first names, relationships, hobbies, important dates.", +"Stated or implied likes, dislikes, preferred styles, or patterns.", +"Important milestones or conclusions within the dialogue.", +"Information that the user explicitly requested to remember or forget." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest": { "description": "Request message for ModelService.MergeVersionAliases.", "id": "GoogleCloudAiplatformV1beta1MergeVersionAliasesRequest", @@ -41002,6 +41984,10 @@ false "$ref": "GoogleCloudAiplatformV1beta1ExactMatchSpec", "description": "Spec for exact match metric." }, +"llmBasedMetricSpec": { +"$ref": "GoogleCloudAiplatformV1beta1LLMBasedMetricSpec", +"description": "Spec for an LLM based metric." +}, "pairwiseMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec", "description": "Spec for pairwise metric." @@ -58080,7 +59066,8 @@ false }, "googleSearchRetrieval": { "$ref": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", -"description": "Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search." +"deprecated": true, +"description": "Optional. Specialized retrieval tool that is powered by Google Search." }, "retrieval": { "$ref": "GoogleCloudAiplatformV1beta1Retrieval", From 51107a656275120000ab499bc8af75ccf4bcd933 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 23 Sep 2025 07:09:06 +0000 Subject: [PATCH 02/26] feat(androidmanagement): update the api #### androidmanagement:v1 The following keys were added: - schemas.ApplicationPolicy.properties.extensionConfig.deprecated (Total Keys: 1) - schemas.ApplicationPolicy.properties.roles (Total Keys: 2) - schemas.ExtensionConfig.properties.notificationReceiver.deprecated (Total Keys: 1) - schemas.Role (Total Keys: 3) --- ...oidmanagement_v1.enterprises.policies.html | 63 ++++++++++++++----- .../documents/androidmanagement.v1.json | 56 +++++++++++++++-- 2 files changed, 99 insertions(+), 20 deletions(-) diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index 3de990d1aa6..71f4aa3a8d2 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -179,7 +179,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. If there is any app with COMPANION_APP role, this field cannot be set.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details). "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hashes of the signing key certificates of the extension app. Only hexadecimal string representations of 64 characters are valid.The signing key certificate fingerprints are always obtained from the Play Store and this field is used to provide additional signing key certificate fingerprints. However, if the application is not available on the Play Store, this field needs to be set. A NonComplianceDetail with INVALID_VALUE is reported if this field is not set when the application is not available on the Play Store.The signing key certificate fingerprint of the extension app on the device must match one of the signing key certificate fingerprints obtained from the Play Store or the ones provided in this field for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", @@ -213,7 +213,12 @@

Method Details

}, ], "preferentialNetworkId": "A String", # Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified in defaultPreferentialNetworkId. See the documentation of defaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above. - "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig + "roles": [ # Optional. Roles the app has.Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of each RoleType for more details.The app is notified about the roles that are set for it if the app has a notification receiver service with . The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) and Manage app roles (https://developers.google.com/android/management/app-roles) guides for more details on the requirements for the service.For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with the same roleType. Multiple apps cannot hold a role with the same roleType. A role with type ROLE_TYPE_UNSPECIFIED is not allowed. + { # Role an app can have. + "roleType": "A String", # Required. The type of the role an app can have. + }, + ], + "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has roles set to a nonempty list and the app does not exist on the Play Store. The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig ApplicationPolicy.roles { # The application signing key certificate. "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. Otherwise, the policy is rejected. }, @@ -682,7 +687,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. If there is any app with COMPANION_APP role, this field cannot be set.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details). "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hashes of the signing key certificates of the extension app. Only hexadecimal string representations of 64 characters are valid.The signing key certificate fingerprints are always obtained from the Play Store and this field is used to provide additional signing key certificate fingerprints. However, if the application is not available on the Play Store, this field needs to be set. A NonComplianceDetail with INVALID_VALUE is reported if this field is not set when the application is not available on the Play Store.The signing key certificate fingerprint of the extension app on the device must match one of the signing key certificate fingerprints obtained from the Play Store or the ones provided in this field for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", @@ -716,7 +721,12 @@

Method Details

}, ], "preferentialNetworkId": "A String", # Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified in defaultPreferentialNetworkId. See the documentation of defaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above. - "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig + "roles": [ # Optional. Roles the app has.Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of each RoleType for more details.The app is notified about the roles that are set for it if the app has a notification receiver service with . The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) and Manage app roles (https://developers.google.com/android/management/app-roles) guides for more details on the requirements for the service.For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with the same roleType. Multiple apps cannot hold a role with the same roleType. A role with type ROLE_TYPE_UNSPECIFIED is not allowed. + { # Role an app can have. + "roleType": "A String", # Required. The type of the role an app can have. + }, + ], + "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has roles set to a nonempty list and the app does not exist on the Play Store. The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig ApplicationPolicy.roles { # The application signing key certificate. "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. Otherwise, the policy is rejected. }, @@ -1167,7 +1177,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. If there is any app with COMPANION_APP role, this field cannot be set.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details). "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hashes of the signing key certificates of the extension app. Only hexadecimal string representations of 64 characters are valid.The signing key certificate fingerprints are always obtained from the Play Store and this field is used to provide additional signing key certificate fingerprints. However, if the application is not available on the Play Store, this field needs to be set. A NonComplianceDetail with INVALID_VALUE is reported if this field is not set when the application is not available on the Play Store.The signing key certificate fingerprint of the extension app on the device must match one of the signing key certificate fingerprints obtained from the Play Store or the ones provided in this field for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", @@ -1201,7 +1211,12 @@

Method Details

}, ], "preferentialNetworkId": "A String", # Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified in defaultPreferentialNetworkId. See the documentation of defaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above. - "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig + "roles": [ # Optional. Roles the app has.Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of each RoleType for more details.The app is notified about the roles that are set for it if the app has a notification receiver service with . The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) and Manage app roles (https://developers.google.com/android/management/app-roles) guides for more details on the requirements for the service.For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with the same roleType. Multiple apps cannot hold a role with the same roleType. A role with type ROLE_TYPE_UNSPECIFIED is not allowed. + { # Role an app can have. + "roleType": "A String", # Required. The type of the role an app can have. + }, + ], + "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has roles set to a nonempty list and the app does not exist on the Play Store. The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig ApplicationPolicy.roles { # The application signing key certificate. "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. Otherwise, the policy is rejected. }, @@ -1266,7 +1281,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. If there is any app with COMPANION_APP role, this field cannot be set.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details). "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hashes of the signing key certificates of the extension app. Only hexadecimal string representations of 64 characters are valid.The signing key certificate fingerprints are always obtained from the Play Store and this field is used to provide additional signing key certificate fingerprints. However, if the application is not available on the Play Store, this field needs to be set. A NonComplianceDetail with INVALID_VALUE is reported if this field is not set when the application is not available on the Play Store.The signing key certificate fingerprint of the extension app on the device must match one of the signing key certificate fingerprints obtained from the Play Store or the ones provided in this field for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", @@ -1300,7 +1315,12 @@

Method Details

}, ], "preferentialNetworkId": "A String", # Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified in defaultPreferentialNetworkId. See the documentation of defaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above. - "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig + "roles": [ # Optional. Roles the app has.Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of each RoleType for more details.The app is notified about the roles that are set for it if the app has a notification receiver service with . The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) and Manage app roles (https://developers.google.com/android/management/app-roles) guides for more details on the requirements for the service.For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with the same roleType. Multiple apps cannot hold a role with the same roleType. A role with type ROLE_TYPE_UNSPECIFIED is not allowed. + { # Role an app can have. + "roleType": "A String", # Required. The type of the role an app can have. + }, + ], + "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has roles set to a nonempty list and the app does not exist on the Play Store. The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig ApplicationPolicy.roles { # The application signing key certificate. "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. Otherwise, the policy is rejected. }, @@ -1760,7 +1780,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. If there is any app with COMPANION_APP role, this field cannot be set.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details). "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hashes of the signing key certificates of the extension app. Only hexadecimal string representations of 64 characters are valid.The signing key certificate fingerprints are always obtained from the Play Store and this field is used to provide additional signing key certificate fingerprints. However, if the application is not available on the Play Store, this field needs to be set. A NonComplianceDetail with INVALID_VALUE is reported if this field is not set when the application is not available on the Play Store.The signing key certificate fingerprint of the extension app on the device must match one of the signing key certificate fingerprints obtained from the Play Store or the ones provided in this field for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", @@ -1794,7 +1814,12 @@

Method Details

}, ], "preferentialNetworkId": "A String", # Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified in defaultPreferentialNetworkId. See the documentation of defaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above. - "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig + "roles": [ # Optional. Roles the app has.Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of each RoleType for more details.The app is notified about the roles that are set for it if the app has a notification receiver service with . The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) and Manage app roles (https://developers.google.com/android/management/app-roles) guides for more details on the requirements for the service.For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with the same roleType. Multiple apps cannot hold a role with the same roleType. A role with type ROLE_TYPE_UNSPECIFIED is not allowed. + { # Role an app can have. + "roleType": "A String", # Required. The type of the role an app can have. + }, + ], + "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has roles set to a nonempty list and the app does not exist on the Play Store. The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig ApplicationPolicy.roles { # The application signing key certificate. "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. Otherwise, the policy is rejected. }, @@ -2252,7 +2277,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. If there is any app with COMPANION_APP role, this field cannot be set.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details). "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hashes of the signing key certificates of the extension app. Only hexadecimal string representations of 64 characters are valid.The signing key certificate fingerprints are always obtained from the Play Store and this field is used to provide additional signing key certificate fingerprints. However, if the application is not available on the Play Store, this field needs to be set. A NonComplianceDetail with INVALID_VALUE is reported if this field is not set when the application is not available on the Play Store.The signing key certificate fingerprint of the extension app on the device must match one of the signing key certificate fingerprints obtained from the Play Store or the ones provided in this field for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", @@ -2286,7 +2311,12 @@

Method Details

}, ], "preferentialNetworkId": "A String", # Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified in defaultPreferentialNetworkId. See the documentation of defaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above. - "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig + "roles": [ # Optional. Roles the app has.Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of each RoleType for more details.The app is notified about the roles that are set for it if the app has a notification receiver service with . The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) and Manage app roles (https://developers.google.com/android/management/app-roles) guides for more details on the requirements for the service.For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with the same roleType. Multiple apps cannot hold a role with the same roleType. A role with type ROLE_TYPE_UNSPECIFIED is not allowed. + { # Role an app can have. + "roleType": "A String", # Required. The type of the role an app can have. + }, + ], + "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has roles set to a nonempty list and the app does not exist on the Play Store. The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig ApplicationPolicy.roles { # The application signing key certificate. "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. Otherwise, the policy is rejected. }, @@ -2760,7 +2790,7 @@

Method Details

"A String", ], "disabled": True or False, # Whether the app is disabled. When disabled, the app data is still preserved. - "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. + "extensionConfig": { # Configuration to enable an app as an extension app, with the capability of interacting with Android Device Policy offline. For Android versions 11 and above, extension apps are exempt from battery restrictions so will not be placed into the restricted App Standby Bucket (https://developer.android.com/topic/performance/appstandby#restricted-bucket). Extensions apps are also protected against users clearing their data or force-closing the application, although admins can continue to use the clear app data command on extension apps if needed for Android 11 and above. # Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. If there is any app with COMPANION_APP role, this field cannot be set.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported. "notificationReceiver": "A String", # Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details). "signingKeyFingerprintsSha256": [ # Hex-encoded SHA-256 hashes of the signing key certificates of the extension app. Only hexadecimal string representations of 64 characters are valid.The signing key certificate fingerprints are always obtained from the Play Store and this field is used to provide additional signing key certificate fingerprints. However, if the application is not available on the Play Store, this field needs to be set. A NonComplianceDetail with INVALID_VALUE is reported if this field is not set when the application is not available on the Play Store.The signing key certificate fingerprint of the extension app on the device must match one of the signing key certificate fingerprints obtained from the Play Store or the ones provided in this field for the app to be able to communicate with Android Device Policy.In production use cases, it is recommended to leave this empty. "A String", @@ -2794,7 +2824,12 @@

Method Details

}, ], "preferentialNetworkId": "A String", # Optional. ID of the preferential network the application uses. There must be a configuration for the specified network ID in preferentialNetworkServiceConfigs. If set to PREFERENTIAL_NETWORK_ID_UNSPECIFIED, the application will use the default network ID specified in defaultPreferentialNetworkId. See the documentation of defaultPreferentialNetworkId for the list of apps excluded from this defaulting. This applies on both work profiles and fully managed devices on Android 13 and above. - "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig + "roles": [ # Optional. Roles the app has.Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of each RoleType for more details.The app is notified about the roles that are set for it if the app has a notification receiver service with . The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) and Manage app roles (https://developers.google.com/android/management/app-roles) guides for more details on the requirements for the service.For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with the same roleType. Multiple apps cannot hold a role with the same roleType. A role with type ROLE_TYPE_UNSPECIFIED is not allowed. + { # Role an app can have. + "roleType": "A String", # Required. The type of the role an app can have. + }, + ], + "signingKeyCerts": [ # Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has roles set to a nonempty list and the app does not exist on the Play Store. The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig ApplicationPolicy.roles { # The application signing key certificate. "signingKeyCertFingerprintSha256": "A String", # Required. The SHA-256 hash value of the signing key certificate of the app. This must be a valid SHA-256 hash value, i.e. 32 bytes. Otherwise, the policy is rejected. }, diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index fbadf698202..625d60c2caa 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1260,7 +1260,7 @@ } } }, -"revision": "20250909", +"revision": "20250916", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -2147,7 +2147,8 @@ }, "extensionConfig": { "$ref": "ExtensionConfig", -"description": "Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported." +"deprecated": true, +"description": "Configuration to enable this app as an extension app, with the capability of interacting with Android Device Policy offline.This field can be set for at most one app. If there is any app with COMPANION_APP role, this field cannot be set.The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts or ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) or the signing key certificate fingerprints obtained from Play Store for the app to be able to communicate with Android Device Policy. If the app is not on Play Store and if ApplicationPolicy.signingKeyCerts and ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) are not set, a NonComplianceDetail with INVALID_VALUE is reported." }, "installConstraint": { "description": "Optional. The constraints for installing the app. You can specify a maximum of one InstallConstraint. Multiple constraints are rejected.", @@ -2173,6 +2174,16 @@ "KIOSK", "CUSTOM" ], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false +], "enumDescriptions": [ "Unspecified. Defaults to AVAILABLE.", "The app is automatically installed and can be removed by the user.", @@ -2180,7 +2191,7 @@ "The app is blocked and can't be installed. If the app was installed under a previous policy, it will be uninstalled. This also blocks its instant app functionality.", "The app is available to install.", "The app is automatically installed and can't be removed by the user and will prevent setup from completion until installation is complete.", -"The app is automatically installed in kiosk mode: it's set as the preferred home intent and whitelisted for lock task mode. Device setup won't complete until the app is installed. After installation, users won't be able to remove the app. You can only set this installType for one app per policy. When this is present in the policy, status bar will be automatically disabled.", +"The app is automatically installed in kiosk mode: it's set as the preferred home intent and whitelisted for lock task mode. Device setup won't complete until the app is installed. After installation, users won't be able to remove the app. You can only set this installType for one app per policy. When this is present in the policy, status bar will be automatically disabled.If there is any app with KIOSK role, then this install type cannot be set for any app.", "The app can only be installed and updated via AMAPI SDK command (https://developers.google.com/android/management/extensibility-sdk-integration).Note: This only affects fully managed devices. Play related fields minimumVersionCode, accessibleTrackIds, autoUpdateMode, installConstraint and installPriority cannot be set for the app. The app isn't available in the Play Store. The app installed on the device has applicationSource set to CUSTOM. The signing key certificate fingerprint of the app on the device must match one of the entries in ApplicationPolicy.signingKeyCerts . Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported. Changing the installType to and from CUSTOM uninstalls the existing app if its signing key certificate fingerprint doesn't match the one from the new app source. Removing the app from applications doesn't uninstall the existing app if it conforms to playStoreMode. See also customAppConfig. This is different from the Google Play Custom App Publishing (https://developers.google.com/android/work/play/custom-app-api/get-started) feature." ], "type": "string" @@ -2240,8 +2251,15 @@ ], "type": "string" }, +"roles": { +"description": "Optional. Roles the app has.Apps having certain roles can be exempted from power and background execution restrictions, suspension and hibernation on Android 14 and above. The user control can also be disallowed for apps with certain roles on Android 11 and above. Refer to the documentation of each RoleType for more details.The app is notified about the roles that are set for it if the app has a notification receiver service with . The app is notified whenever its roles are updated or after the app is installed when it has nonempty list of roles. The app can use this notification to bootstrap itself after the installation. See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) and Manage app roles (https://developers.google.com/android/management/app-roles) guides for more details on the requirements for the service.For the exemptions to be applied and the app to be notified about the roles, the signing key certificate fingerprint of the app on the device must match one of the signing key certificate fingerprints obtained from Play Store or one of the entries in ApplicationPolicy.signingKeyCerts. Otherwise, a NonComplianceDetail with APP_SIGNING_CERT_MISMATCH is reported.There must not be duplicate roles with the same roleType. Multiple apps cannot hold a role with the same roleType. A role with type ROLE_TYPE_UNSPECIFIED is not allowed.", +"items": { +"$ref": "Role" +}, +"type": "array" +}, "signingKeyCerts": { -"description": "Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig", +"description": "Optional. Signing key certificates of the app.This field is required in the following cases: The app has installType set to CUSTOM (i.e. a custom app). The app has roles set to a nonempty list and the app does not exist on the Play Store. The app has extensionConfig set (i.e. an extension app) but ExtensionConfig.signingKeyFingerprintsSha256 (deprecated) is not set and the app does not exist on the Play Store.If this field is not set for a custom app, the policy is rejected. If it is not set when required for a non-custom app, a NonComplianceDetail with INVALID_VALUE is reported.For other cases, this field is optional and the signing key certificates obtained from Play Store are used.See following policy settings to see how this field is used: choosePrivateKeyRules ApplicationPolicy.InstallType.CUSTOM ApplicationPolicy.extensionConfig ApplicationPolicy.roles", "items": { "$ref": "ApplicationSigningKeyCert" }, @@ -2255,8 +2273,8 @@ "USER_CONTROL_DISALLOWED" ], "enumDescriptions": [ -"Uses the default behaviour of the app to determine if user control is allowed or disallowed. User control is allowed by default for most apps but disallowed for following types of apps: extension apps (see extensionConfig for more details) kiosk apps (see KIOSK install type for more details) other critical system apps", -"User control is allowed for the app. Kiosk apps can use this to allow user control. For extension apps (see extensionConfig for more details), user control is disallowed even if this value is set. For kiosk apps (see KIOSK install type for more details), this value can be used to allow user control.", +"Uses the default behaviour of the app to determine if user control is allowed or disallowed. User control is allowed by default for most apps but disallowed for following types of apps: extension apps (see extensionConfig for more details) kiosk apps (see KIOSK install type for more details) apps with roles set to a nonempty list other critical system apps", +"User control is allowed for the app. Kiosk apps can use this to allow user control. For extension apps (see extensionConfig for more details), user control is disallowed even if this value is set.For apps with roles set to a nonempty list (except roles containing only KIOSK role), this value cannot be set.For kiosk apps (see KIOSK install type and KIOSK role type for more details), this value can be used to allow user control.", "User control is disallowed for the app. This is supported on Android 11 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 11." ], "type": "string" @@ -3958,6 +3976,7 @@ false "id": "ExtensionConfig", "properties": { "notificationReceiver": { +"deprecated": true, "description": "Fully qualified class name of the receiver service class for Android Device Policy to notify the extension app of any local command status updates. The service must be exported in the extension app's AndroidManifest.xml and extend NotificationReceiverService (https://developers.google.com/android/management/reference/amapi/com/google/android/managementapi/notification/NotificationReceiverService) (see Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details).", "type": "string" }, @@ -6848,6 +6867,31 @@ false }, "type": "object" }, +"Role": { +"description": "Role an app can have.", +"id": "Role", +"properties": { +"roleType": { +"description": "Required. The type of the role an app can have.", +"enum": [ +"ROLE_TYPE_UNSPECIFIED", +"COMPANION_APP", +"KIOSK", +"MOBILE_THREAT_DEFENSE_ENDPOINT_DETECTION_RESPONSE", +"SYSTEM_HEALTH_MONITORING" +], +"enumDescriptions": [ +"The role type is unspecified. This value must not be used.", +"The role type for companion apps. This role enables the app as a companion app with the capability of interacting with Android Device Policy offline. This is the recommended way to configure an app as a companion app. For legacy way, see extensionConfig.On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed for the app with this role. userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app with this role.Android Device Policy notifies the companion app of any local command status updates if the app has a service with . See Integrate with the AMAPI SDK (https://developers.google.com/android/management/sdk-integration) guide for more details on the requirements for the service.", +"The role type for kiosk apps. An app can have this role only if it has installType set to REQUIRED_FOR_SETUP or CUSTOM. Before adding this role to an app with CUSTOM install type, the app must already be installed on the device.The app having this role type is set as the preferred home intent and allowlisted for lock task mode. When there is an app with this role type, status bar will be automatically disabled.This is preferable to setting installType to KIOSK.On Android 11 and above, the user control is disallowed but userControlSettings can be set to USER_CONTROL_ALLOWED to allow user control for the app with this role.", +"The role type for Mobile Threat Defense (MTD) / Endpoint Detection & Response (EDR) apps.On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed and userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app with this role.", +"The role type for system health monitoring apps.On Android 14 and above, the app with this role is exempted from power and background execution restrictions, suspension and hibernation. On Android 11 and above, the user control is disallowed and userControlSettings cannot be set to USER_CONTROL_ALLOWED for the app with this role." +], +"type": "string" +} +}, +"type": "object" +}, "ScreenBrightnessSettings": { "description": "Controls for the screen brightness settings.", "id": "ScreenBrightnessSettings", From ce919522452b844c8c9b7a9621737b8fdb8a948d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 23 Sep 2025 07:09:06 +0000 Subject: [PATCH 03/26] feat(bigquery): update the api #### bigquery:v2 The following keys were added: - schemas.IncrementalResultStats (Total Keys: 7) - schemas.IndexPruningStats (Total Keys: 7) - schemas.JobStatistics2.properties.incrementalResultStats (Total Keys: 2) - schemas.PruningStats (Total Keys: 8) - schemas.SearchStatistics.properties.indexPruningStats (Total Keys: 2) - schemas.TableMetadataCacheUsage.properties.pruningStats.$ref (Total Keys: 1) - schemas.TrainingOptions.properties.endpointIdleTtl (Total Keys: 2) - schemas.TrainingOptions.properties.huggingFaceModelId.type (Total Keys: 1) - schemas.TrainingOptions.properties.machineType.type (Total Keys: 1) - schemas.TrainingOptions.properties.maxReplicaCount (Total Keys: 2) - schemas.TrainingOptions.properties.minReplicaCount (Total Keys: 2) - schemas.TrainingOptions.properties.modelGardenModelName.type (Total Keys: 1) - schemas.TrainingOptions.properties.reservationAffinityKey.type (Total Keys: 1) - schemas.TrainingOptions.properties.reservationAffinityType.type (Total Keys: 1) - schemas.TrainingOptions.properties.reservationAffinityValues (Total Keys: 2) --- docs/dyn/bigquery_v2.jobs.html | 210 +++++++++++++++--- docs/dyn/bigquery_v2.models.html | 88 ++++++++ .../documents/bigquery.v2.json | 154 ++++++++++++- 3 files changed, 421 insertions(+), 31 deletions(-) diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index fc99cb89a15..23fdaf46782 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -175,7 +175,7 @@

Method Details

}, "useAvroLogicalTypes": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. }, - "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. "jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -300,7 +300,7 @@

Method Details

}, "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property. - "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. "A String", ], "skipLeadingRows": 42, # Optional. The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. @@ -396,7 +396,7 @@

Method Details

"start": "A String", # [Experimental] The start of range partitioning, inclusive. }, }, - "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. "A String", ], "scriptOptions": { # Options related to script execution. # Options controlling the execution of scripts. @@ -699,7 +699,7 @@

Method Details

}, "externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs. { # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only. - "billingMethod": "A String", # The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility. + "billingMethod": "A String", # The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility. "bytesBilled": "A String", # External service cost in terms of bigquery bytes billed. "bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed. "externalService": "A String", # External service name. @@ -707,6 +707,11 @@

Method Details

"slotMs": "A String", # External service cost in terms of bigquery slot milliseconds. }, ], + "incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. + "disabledReason": "A String", # Reason why incremental query results are/were not written by the query. + "resultSetLastModifyTime": "A String", # The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed. + "resultSetLastReplaceTime": "A String", # The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed. + }, "loadQueryStatistics": { # Statistics for a LOAD query. # Output only. Statistics for a LOAD query. "badRecords": "A String", # Output only. The number of bad records encountered while processing a LOAD query. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. "bytesTransferred": "A String", # Output only. This field is deprecated. The number of bytes of source data copied over the network for a `LOAD` query. `transferred_bytes` has the canonical value for physical transferred bytes, which is used for BigQuery Omni billing. @@ -733,6 +738,11 @@

Method Details

"tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query. { # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query. "explanation": "A String", # Free form human-readable reason metadata caching was unused for the job. + "pruningStats": { # The column metadata index pruning statistics. # The column metadata index pruning statistics. + "postCmetaPruningParallelInputCount": "A String", # The number of parallel inputs matched. + "postCmetaPruningPartitionCount": "A String", # The number of partitions matched. + "preCmetaPruningParallelInputCount": "A String", # The number of parallel inputs scanned. + }, "staleness": "A String", # Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job). "tableReference": { # Metadata caching eligible table referenced in the query. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -1072,6 +1082,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -1087,6 +1098,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -1107,15 +1119,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -1132,6 +1148,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -1384,6 +1405,17 @@

Method Details

}, }, "searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics. + "indexPruningStats": [ # Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. + { # Statistics for index pruning. + "baseTable": { # The base table reference. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "postIndexPruningParallelInputCount": "A String", # The number of parallel inputs after index pruning. + "preIndexPruningParallelInputCount": "A String", # The number of parallel inputs before index pruning. + }, + ], "indexUnusedReasons": [ # When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. { # Reason about why no search index was used in the search query (or sub-query). "baseTable": { # Specifies the base table involved in the reason that no search index was used. @@ -1427,7 +1459,7 @@

Method Details

"totalBytesProcessed": "A String", # Output only. Total bytes processed for the job. "totalBytesProcessedAccuracy": "A String", # Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. "totalPartitionsProcessed": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job. - "totalServicesSkuSlotMs": "A String", # Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU". + "totalServicesSkuSlotMs": "A String", # Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `"SERVICES_SKU"`. "totalSlotMs": "A String", # Output only. Slot-milliseconds for the job. "transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS). "undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation. @@ -1644,7 +1676,7 @@

Method Details

}, "useAvroLogicalTypes": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. }, - "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. "jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -1769,7 +1801,7 @@

Method Details

}, "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property. - "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. "A String", ], "skipLeadingRows": 42, # Optional. The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. @@ -1865,7 +1897,7 @@

Method Details

"start": "A String", # [Experimental] The start of range partitioning, inclusive. }, }, - "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. "A String", ], "scriptOptions": { # Options related to script execution. # Options controlling the execution of scripts. @@ -2168,7 +2200,7 @@

Method Details

}, "externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs. { # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only. - "billingMethod": "A String", # The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility. + "billingMethod": "A String", # The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility. "bytesBilled": "A String", # External service cost in terms of bigquery bytes billed. "bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed. "externalService": "A String", # External service name. @@ -2176,6 +2208,11 @@

Method Details

"slotMs": "A String", # External service cost in terms of bigquery slot milliseconds. }, ], + "incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. + "disabledReason": "A String", # Reason why incremental query results are/were not written by the query. + "resultSetLastModifyTime": "A String", # The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed. + "resultSetLastReplaceTime": "A String", # The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed. + }, "loadQueryStatistics": { # Statistics for a LOAD query. # Output only. Statistics for a LOAD query. "badRecords": "A String", # Output only. The number of bad records encountered while processing a LOAD query. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. "bytesTransferred": "A String", # Output only. This field is deprecated. The number of bytes of source data copied over the network for a `LOAD` query. `transferred_bytes` has the canonical value for physical transferred bytes, which is used for BigQuery Omni billing. @@ -2202,6 +2239,11 @@

Method Details

"tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query. { # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query. "explanation": "A String", # Free form human-readable reason metadata caching was unused for the job. + "pruningStats": { # The column metadata index pruning statistics. # The column metadata index pruning statistics. + "postCmetaPruningParallelInputCount": "A String", # The number of parallel inputs matched. + "postCmetaPruningPartitionCount": "A String", # The number of partitions matched. + "preCmetaPruningParallelInputCount": "A String", # The number of parallel inputs scanned. + }, "staleness": "A String", # Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job). "tableReference": { # Metadata caching eligible table referenced in the query. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -2541,6 +2583,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -2556,6 +2599,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -2576,15 +2620,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -2601,6 +2649,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -2853,6 +2906,17 @@

Method Details

}, }, "searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics. + "indexPruningStats": [ # Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. + { # Statistics for index pruning. + "baseTable": { # The base table reference. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "postIndexPruningParallelInputCount": "A String", # The number of parallel inputs after index pruning. + "preIndexPruningParallelInputCount": "A String", # The number of parallel inputs before index pruning. + }, + ], "indexUnusedReasons": [ # When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. { # Reason about why no search index was used in the search query (or sub-query). "baseTable": { # Specifies the base table involved in the reason that no search index was used. @@ -2896,7 +2960,7 @@

Method Details

"totalBytesProcessed": "A String", # Output only. Total bytes processed for the job. "totalBytesProcessedAccuracy": "A String", # Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. "totalPartitionsProcessed": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job. - "totalServicesSkuSlotMs": "A String", # Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU". + "totalServicesSkuSlotMs": "A String", # Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `"SERVICES_SKU"`. "totalSlotMs": "A String", # Output only. Slot-milliseconds for the job. "transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS). "undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation. @@ -3200,7 +3264,7 @@

Method Details

}, "useAvroLogicalTypes": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. }, - "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. "jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -3325,7 +3389,7 @@

Method Details

}, "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property. - "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. "A String", ], "skipLeadingRows": 42, # Optional. The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. @@ -3421,7 +3485,7 @@

Method Details

"start": "A String", # [Experimental] The start of range partitioning, inclusive. }, }, - "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. "A String", ], "scriptOptions": { # Options related to script execution. # Options controlling the execution of scripts. @@ -3724,7 +3788,7 @@

Method Details

}, "externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs. { # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only. - "billingMethod": "A String", # The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility. + "billingMethod": "A String", # The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility. "bytesBilled": "A String", # External service cost in terms of bigquery bytes billed. "bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed. "externalService": "A String", # External service name. @@ -3732,6 +3796,11 @@

Method Details

"slotMs": "A String", # External service cost in terms of bigquery slot milliseconds. }, ], + "incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. + "disabledReason": "A String", # Reason why incremental query results are/were not written by the query. + "resultSetLastModifyTime": "A String", # The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed. + "resultSetLastReplaceTime": "A String", # The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed. + }, "loadQueryStatistics": { # Statistics for a LOAD query. # Output only. Statistics for a LOAD query. "badRecords": "A String", # Output only. The number of bad records encountered while processing a LOAD query. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. "bytesTransferred": "A String", # Output only. This field is deprecated. The number of bytes of source data copied over the network for a `LOAD` query. `transferred_bytes` has the canonical value for physical transferred bytes, which is used for BigQuery Omni billing. @@ -3758,6 +3827,11 @@

Method Details

"tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query. { # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query. "explanation": "A String", # Free form human-readable reason metadata caching was unused for the job. + "pruningStats": { # The column metadata index pruning statistics. # The column metadata index pruning statistics. + "postCmetaPruningParallelInputCount": "A String", # The number of parallel inputs matched. + "postCmetaPruningPartitionCount": "A String", # The number of partitions matched. + "preCmetaPruningParallelInputCount": "A String", # The number of parallel inputs scanned. + }, "staleness": "A String", # Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job). "tableReference": { # Metadata caching eligible table referenced in the query. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -4097,6 +4171,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -4112,6 +4187,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -4132,15 +4208,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -4157,6 +4237,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -4409,6 +4494,17 @@

Method Details

}, }, "searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics. + "indexPruningStats": [ # Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. + { # Statistics for index pruning. + "baseTable": { # The base table reference. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "postIndexPruningParallelInputCount": "A String", # The number of parallel inputs after index pruning. + "preIndexPruningParallelInputCount": "A String", # The number of parallel inputs before index pruning. + }, + ], "indexUnusedReasons": [ # When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. { # Reason about why no search index was used in the search query (or sub-query). "baseTable": { # Specifies the base table involved in the reason that no search index was used. @@ -4452,7 +4548,7 @@

Method Details

"totalBytesProcessed": "A String", # Output only. Total bytes processed for the job. "totalBytesProcessedAccuracy": "A String", # Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. "totalPartitionsProcessed": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job. - "totalServicesSkuSlotMs": "A String", # Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU". + "totalServicesSkuSlotMs": "A String", # Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `"SERVICES_SKU"`. "totalSlotMs": "A String", # Output only. Slot-milliseconds for the job. "transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS). "undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation. @@ -4640,7 +4736,7 @@

Method Details

}, "useAvroLogicalTypes": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. }, - "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. "jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -4765,7 +4861,7 @@

Method Details

}, "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property. - "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. "A String", ], "skipLeadingRows": 42, # Optional. The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. @@ -4861,7 +4957,7 @@

Method Details

"start": "A String", # [Experimental] The start of range partitioning, inclusive. }, }, - "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. "A String", ], "scriptOptions": { # Options related to script execution. # Options controlling the execution of scripts. @@ -5164,7 +5260,7 @@

Method Details

}, "externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs. { # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only. - "billingMethod": "A String", # The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility. + "billingMethod": "A String", # The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility. "bytesBilled": "A String", # External service cost in terms of bigquery bytes billed. "bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed. "externalService": "A String", # External service name. @@ -5172,6 +5268,11 @@

Method Details

"slotMs": "A String", # External service cost in terms of bigquery slot milliseconds. }, ], + "incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. + "disabledReason": "A String", # Reason why incremental query results are/were not written by the query. + "resultSetLastModifyTime": "A String", # The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed. + "resultSetLastReplaceTime": "A String", # The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed. + }, "loadQueryStatistics": { # Statistics for a LOAD query. # Output only. Statistics for a LOAD query. "badRecords": "A String", # Output only. The number of bad records encountered while processing a LOAD query. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. "bytesTransferred": "A String", # Output only. This field is deprecated. The number of bytes of source data copied over the network for a `LOAD` query. `transferred_bytes` has the canonical value for physical transferred bytes, which is used for BigQuery Omni billing. @@ -5198,6 +5299,11 @@

Method Details

"tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query. { # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query. "explanation": "A String", # Free form human-readable reason metadata caching was unused for the job. + "pruningStats": { # The column metadata index pruning statistics. # The column metadata index pruning statistics. + "postCmetaPruningParallelInputCount": "A String", # The number of parallel inputs matched. + "postCmetaPruningPartitionCount": "A String", # The number of partitions matched. + "preCmetaPruningParallelInputCount": "A String", # The number of parallel inputs scanned. + }, "staleness": "A String", # Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job). "tableReference": { # Metadata caching eligible table referenced in the query. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -5537,6 +5643,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -5552,6 +5659,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -5572,15 +5680,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -5597,6 +5709,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -5849,6 +5966,17 @@

Method Details

}, }, "searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics. + "indexPruningStats": [ # Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. + { # Statistics for index pruning. + "baseTable": { # The base table reference. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "postIndexPruningParallelInputCount": "A String", # The number of parallel inputs after index pruning. + "preIndexPruningParallelInputCount": "A String", # The number of parallel inputs before index pruning. + }, + ], "indexUnusedReasons": [ # When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. { # Reason about why no search index was used in the search query (or sub-query). "baseTable": { # Specifies the base table involved in the reason that no search index was used. @@ -5892,7 +6020,7 @@

Method Details

"totalBytesProcessed": "A String", # Output only. Total bytes processed for the job. "totalBytesProcessedAccuracy": "A String", # Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. "totalPartitionsProcessed": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job. - "totalServicesSkuSlotMs": "A String", # Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU". + "totalServicesSkuSlotMs": "A String", # Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `"SERVICES_SKU"`. "totalSlotMs": "A String", # Output only. Slot-milliseconds for the job. "transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS). "undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation. @@ -6103,7 +6231,7 @@

Method Details

}, "useAvroLogicalTypes": True or False, # Whether to use logical types when extracting to AVRO format. Not applicable when extracting models. }, - "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. + "jobTimeoutMs": "A String", # Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete. "jobType": "A String", # Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. "labels": { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. "a_key": "A String", @@ -6228,7 +6356,7 @@

Method Details

}, "schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". "schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property. - "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. "A String", ], "skipLeadingRows": 42, # Optional. The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema. @@ -6324,7 +6452,7 @@

Method Details

"start": "A String", # [Experimental] The start of range partitioning, inclusive. }, }, - "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. + "schemaUpdateOptions": [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable. "A String", ], "scriptOptions": { # Options related to script execution. # Options controlling the execution of scripts. @@ -6629,7 +6757,7 @@

Method Details

}, "externalServiceCosts": [ # Output only. Job cost breakdown as bigquery internal cost and external service costs. { # The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only. - "billingMethod": "A String", # The billing method used for the external job. This field is only used when billed on the services sku, set to "SERVICES_SKU". Otherwise, it is unspecified for backward compatibility. + "billingMethod": "A String", # The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility. "bytesBilled": "A String", # External service cost in terms of bigquery bytes billed. "bytesProcessed": "A String", # External service cost in terms of bigquery bytes processed. "externalService": "A String", # External service name. @@ -6637,6 +6765,11 @@

Method Details

"slotMs": "A String", # External service cost in terms of bigquery slot milliseconds. }, ], + "incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available. + "disabledReason": "A String", # Reason why incremental query results are/were not written by the query. + "resultSetLastModifyTime": "A String", # The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed. + "resultSetLastReplaceTime": "A String", # The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed. + }, "loadQueryStatistics": { # Statistics for a LOAD query. # Output only. Statistics for a LOAD query. "badRecords": "A String", # Output only. The number of bad records encountered while processing a LOAD query. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data. "bytesTransferred": "A String", # Output only. This field is deprecated. The number of bytes of source data copied over the network for a `LOAD` query. `transferred_bytes` has the canonical value for physical transferred bytes, which is used for BigQuery Omni billing. @@ -6663,6 +6796,11 @@

Method Details

"tableMetadataCacheUsage": [ # Set for the Metadata caching eligible tables referenced in the query. { # Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query. "explanation": "A String", # Free form human-readable reason metadata caching was unused for the job. + "pruningStats": { # The column metadata index pruning statistics. # The column metadata index pruning statistics. + "postCmetaPruningParallelInputCount": "A String", # The number of parallel inputs matched. + "postCmetaPruningPartitionCount": "A String", # The number of partitions matched. + "preCmetaPruningParallelInputCount": "A String", # The number of parallel inputs scanned. + }, "staleness": "A String", # Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job). "tableReference": { # Metadata caching eligible table referenced in the query. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -7002,6 +7140,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -7017,6 +7156,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -7037,15 +7177,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -7062,6 +7206,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -7314,6 +7463,17 @@

Method Details

}, }, "searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics. + "indexPruningStats": [ # Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. + { # Statistics for index pruning. + "baseTable": { # The base table reference. + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + "postIndexPruningParallelInputCount": "A String", # The number of parallel inputs after index pruning. + "preIndexPruningParallelInputCount": "A String", # The number of parallel inputs before index pruning. + }, + ], "indexUnusedReasons": [ # When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. { # Reason about why no search index was used in the search query (or sub-query). "baseTable": { # Specifies the base table involved in the reason that no search index was used. @@ -7357,7 +7517,7 @@

Method Details

"totalBytesProcessed": "A String", # Output only. Total bytes processed for the job. "totalBytesProcessedAccuracy": "A String", # Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. "totalPartitionsProcessed": "A String", # Output only. Total number of partitions processed from all partitioned tables referenced in the job. - "totalServicesSkuSlotMs": "A String", # Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is "SERVICES_SKU". + "totalServicesSkuSlotMs": "A String", # Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `"SERVICES_SKU"`. "totalSlotMs": "A String", # Output only. Slot-milliseconds for the job. "transferredBytes": "A String", # Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS). "undeclaredQueryParameters": [ # Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation. diff --git a/docs/dyn/bigquery_v2.models.html b/docs/dyn/bigquery_v2.models.html index b65f4e47fdb..441d710ef2c 100644 --- a/docs/dyn/bigquery_v2.models.html +++ b/docs/dyn/bigquery_v2.models.html @@ -685,6 +685,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -700,6 +701,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -720,15 +722,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -745,6 +751,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -1081,6 +1092,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -1096,6 +1108,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -1116,15 +1129,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -1141,6 +1158,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -1765,6 +1787,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -1780,6 +1803,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -1800,15 +1824,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -1825,6 +1853,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -2161,6 +2194,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -2176,6 +2210,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -2196,15 +2231,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -2221,6 +2260,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -2854,6 +2898,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -2869,6 +2914,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -2889,15 +2935,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -2914,6 +2964,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -3250,6 +3305,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -3265,6 +3321,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -3285,15 +3342,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -3310,6 +3371,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -3922,6 +3988,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -3937,6 +4004,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -3957,15 +4025,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -3982,6 +4054,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. @@ -4318,6 +4395,7 @@

Method Details

"dropout": 3.14, # Dropout probability for dnn models. "earlyStop": True or False, # Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms. "enableGlobalExplain": True or False, # If true, enable global explanation during training. + "endpointIdleTtl": "A String", # The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours. "feedbackType": "A String", # Feedback type that specifies which algorithm to run for matrix factorization. "fitIntercept": True or False, # Whether the model should include intercept during model training. "forecastLimitLowerBound": 3.14, # The forecast limit lower bound that was used during ARIMA model training with limits. To see more details of the algorithm: https://otexts.com/fpp2/limits.html @@ -4333,6 +4411,7 @@

Method Details

"hparamTuningObjectives": [ # The target evaluation metrics to optimize the hyperparameters for. "A String", ], + "huggingFaceModelId": "A String", # The id of a Hugging Face model. For example, `google/gemma-2-2b-it`. "includeDrift": True or False, # Include drift when fitting an ARIMA model. "initialLearnRate": 3.14, # Specifies the initial learning rate for the line search learn rate strategy. "inputLabelColumns": [ # Name of input label columns in training data. @@ -4353,15 +4432,19 @@

Method Details

"learnRate": 3.14, # Learning rate in training. Used only for iterative training algorithms. "learnRateStrategy": "A String", # The strategy to determine learn rate for the current iteration. "lossType": "A String", # Type of loss function used during training run. + "machineType": "A String", # The type of the machine used to deploy and serve the model. "maxIterations": "A String", # The maximum number of iterations in training. Used only for iterative training algorithms. "maxParallelTrials": "A String", # Maximum number of trials to run in parallel. + "maxReplicaCount": "A String", # The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count. "maxTimeSeriesLength": "A String", # The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options. "maxTreeDepth": "A String", # Maximum depth of a tree for boosted tree models. "minAprioriSupport": 3.14, # The apriori support minimum. Applies to contribution analysis models. "minRelativeProgress": 3.14, # When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. + "minReplicaCount": "A String", # The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1. "minSplitLoss": 3.14, # Minimum split loss for boosted tree models. "minTimeSeriesLength": "A String", # The minimum number of time points in a time series that are used in modeling the trend component of the time series. If you use this option you must also set the `timeSeriesLengthFraction` option. This training option ensures that enough time points are available when you use `timeSeriesLengthFraction` in trend modeling. This is particularly important when forecasting multiple time series in a single query using `timeSeriesIdColumn`. If the total number of time points is less than the `minTimeSeriesLength` value, then the query uses all available time points. "minTreeChildWeight": "A String", # Minimum sum of instance weight needed in a child for boosted tree models. + "modelGardenModelName": "A String", # The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`. "modelRegistry": "A String", # The model registry. "modelUri": "A String", # Google Cloud Storage URI from which the model was imported. Only applicable for imported models. "nonSeasonalOrder": { # Arima order, can be used for both non-seasonal and seasonal parts. # A specification of the non-seasonal part of the ARIMA model: the three components (p, d, q) are the AR order, the degree of differencing, and the MA order. @@ -4378,6 +4461,11 @@

Method Details

"optimizer": "A String", # Optimizer used for training the neural nets. "pcaExplainedVarianceRatio": 3.14, # The minimum ratio of cumulative explained variance that needs to be given by the PCA model. "pcaSolver": "A String", # The solver for PCA. + "reservationAffinityKey": "A String", # Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + "reservationAffinityType": "A String", # Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`. + "reservationAffinityValues": [ # Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block. + "A String", + ], "sampledShapleyNumPaths": "A String", # Number of paths for the sampled Shapley explain method. "scaleFeatures": True or False, # If true, scale the feature values by dividing the feature standard deviation. Currently only apply to PCA. "standardizeFeatures": True or False, # Whether to standardize numerical features. Default to true. diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 658e9bd9f6a..a1da6a16cf9 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -2375,7 +2375,7 @@ } } }, -"revision": "20250816", +"revision": "20250912", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -4692,7 +4692,7 @@ "id": "ExternalServiceCost", "properties": { "billingMethod": { -"description": "The billing method used for the external job. This field is only used when billed on the services sku, set to \"SERVICES_SKU\". Otherwise, it is unspecified for backward compatibility.", +"description": "The billing method used for the external job. This field, set to `SERVICES_SKU`, is only used when billing under the services SKU. Otherwise, it is unspecified for backward compatibility.", "type": "string" }, "bytesBilled": { @@ -5140,6 +5140,56 @@ }, "type": "object" }, +"IncrementalResultStats": { +"description": "Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available.", +"id": "IncrementalResultStats", +"properties": { +"disabledReason": { +"description": "Reason why incremental query results are/were not written by the query.", +"enum": [ +"DISABLED_REASON_UNSPECIFIED", +"OTHER" +], +"enumDescriptions": [ +"Disabled reason not specified.", +"Some other reason." +], +"type": "string" +}, +"resultSetLastModifyTime": { +"description": "The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed.", +"format": "google-datetime", +"type": "string" +}, +"resultSetLastReplaceTime": { +"description": "The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"IndexPruningStats": { +"description": "Statistics for index pruning.", +"id": "IndexPruningStats", +"properties": { +"baseTable": { +"$ref": "TableReference", +"description": "The base table reference." +}, +"postIndexPruningParallelInputCount": { +"description": "The number of parallel inputs after index pruning.", +"format": "int64", +"type": "string" +}, +"preIndexPruningParallelInputCount": { +"description": "The number of parallel inputs before index pruning.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "IndexUnusedReason": { "description": "Reason about why no search index was used in the search query (or sub-query).", "id": "IndexUnusedReason", @@ -5442,7 +5492,7 @@ "description": "[Pick one] Configures an extract job." }, "jobTimeoutMs": { -"description": "Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery will attempt to stop a longer job, but may not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete.", +"description": "Optional. Job timeout in milliseconds relative to the job creation time. If this time limit is exceeded, BigQuery attempts to stop the job, but might not always succeed in canceling it before the job completes. For example, a job that takes more than 60 seconds to complete has a better chance of being stopped than a job that takes 10 seconds to complete.", "format": "int64", "type": "string" }, @@ -5720,7 +5770,7 @@ "type": "string" }, "schemaUpdateOptions": { -"description": "Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", +"description": "Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", "items": { "type": "string" }, @@ -5871,7 +5921,7 @@ "description": "Range partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified." }, "schemaUpdateOptions": { -"description": "Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", +"description": "Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in three cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE_DATA; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: * ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. * ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.", "items": { "type": "string" }, @@ -6356,6 +6406,11 @@ "readOnly": true, "type": "array" }, +"incrementalResultStats": { +"$ref": "IncrementalResultStats", +"description": "Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available.", +"readOnly": true +}, "loadQueryStatistics": { "$ref": "LoadQueryStatistics", "description": "Output only. Statistics for a LOAD query.", @@ -6503,7 +6558,7 @@ "type": "string" }, "totalServicesSkuSlotMs": { -"description": "Output only. Total slot-milliseconds for the job that run on external services and billed on the service SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is \"SERVICES_SKU\".", +"description": "Output only. Total slot milliseconds for the job that ran on external services and billed on the services SKU. This field is only populated for jobs that have external service costs, and is the total of the usage for costs whose billing method is `\"SERVICES_SKU\"`.", "format": "int64", "readOnly": true, "type": "string" @@ -7595,6 +7650,28 @@ }, "type": "object" }, +"PruningStats": { +"description": "The column metadata index pruning statistics.", +"id": "PruningStats", +"properties": { +"postCmetaPruningParallelInputCount": { +"description": "The number of parallel inputs matched.", +"format": "int64", +"type": "string" +}, +"postCmetaPruningPartitionCount": { +"description": "The number of partitions matched.", +"format": "int64", +"type": "string" +}, +"preCmetaPruningParallelInputCount": { +"description": "The number of parallel inputs scanned.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "PythonOptions": { "description": "Options for a user-defined Python function.", "id": "PythonOptions", @@ -8589,6 +8666,13 @@ "description": "Statistics for a search query. Populated as part of JobStatistics2.", "id": "SearchStatistics", "properties": { +"indexPruningStats": { +"description": "Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table.", +"items": { +"$ref": "IndexPruningStats" +}, +"type": "array" +}, "indexUnusedReasons": { "description": "When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated.", "items": { @@ -9825,6 +9909,10 @@ "description": "Free form human-readable reason metadata caching was unused for the job.", "type": "string" }, +"pruningStats": { +"$ref": "PruningStats", +"description": "The column metadata index pruning statistics." +}, "staleness": { "description": "Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job).", "format": "google-duration", @@ -10233,6 +10321,11 @@ "description": "If true, enable global explanation during training.", "type": "boolean" }, +"endpointIdleTtl": { +"description": "The idle TTL of the endpoint before the resources get destroyed. The default value is 6.5 hours.", +"format": "google-duration", +"type": "string" +}, "feedbackType": { "description": "Feedback type that specifies which algorithm to run for matrix factorization.", "enum": [ @@ -10614,6 +10707,10 @@ }, "type": "array" }, +"huggingFaceModelId": { +"description": "The id of a Hugging Face model. For example, `google/gemma-2-2b-it`.", +"type": "string" +}, "includeDrift": { "description": "Include drift when fitting an ARIMA model.", "type": "boolean" @@ -10723,6 +10820,10 @@ ], "type": "string" }, +"machineType": { +"description": "The type of the machine used to deploy and serve the model.", +"type": "string" +}, "maxIterations": { "description": "The maximum number of iterations in training. Used only for iterative training algorithms.", "format": "int64", @@ -10733,6 +10834,11 @@ "format": "int64", "type": "string" }, +"maxReplicaCount": { +"description": "The maximum number of machine replicas that will be deployed on an endpoint. The default value is equal to min_replica_count.", +"format": "int64", +"type": "string" +}, "maxTimeSeriesLength": { "description": "The maximum number of time points in a time series that can be used in modeling the trend component of the time series. Don't use this option with the `timeSeriesLengthFraction` or `minTimeSeriesLength` options.", "format": "int64", @@ -10753,6 +10859,11 @@ "format": "double", "type": "number" }, +"minReplicaCount": { +"description": "The minimum number of machine replicas that will be always deployed on an endpoint. This value must be greater than or equal to 1. The default value is 1.", +"format": "int64", +"type": "string" +}, "minSplitLoss": { "description": "Minimum split loss for boosted tree models.", "format": "double", @@ -10768,6 +10879,10 @@ "format": "int64", "type": "string" }, +"modelGardenModelName": { +"description": "The name of a Vertex model garden publisher model. Format is `publishers/{publisher}/models/{model}@{optional_version_id}`.", +"type": "string" +}, "modelRegistry": { "description": "The model registry.", "enum": [ @@ -10852,6 +10967,33 @@ ], "type": "string" }, +"reservationAffinityKey": { +"description": "Corresponds to the label key of a reservation resource used by Vertex AI. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.", +"type": "string" +}, +"reservationAffinityType": { +"description": "Specifies the reservation affinity type used to configure a Vertex AI resource. The default value is `NO_RESERVATION`.", +"enum": [ +"RESERVATION_AFFINITY_TYPE_UNSPECIFIED", +"NO_RESERVATION", +"ANY_RESERVATION", +"SPECIFIC_RESERVATION" +], +"enumDescriptions": [ +"Default value.", +"No reservation.", +"Any reservation.", +"Specific reservation." +], +"type": "string" +}, +"reservationAffinityValues": { +"description": "Corresponds to the label values of a reservation resource used by Vertex AI. This must be the full resource name of the reservation or reservation block.", +"items": { +"type": "string" +}, +"type": "array" +}, "sampledShapleyNumPaths": { "description": "Number of paths for the sampled Shapley explain method.", "format": "int64", From ebae81ea64e6b7794d00a3fc556f0d3cbb9a1c4b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 23 Sep 2025 07:09:06 +0000 Subject: [PATCH 04/26] feat(bigtableadmin): update the api #### bigtableadmin:v2 The following keys were deleted: - schemas.CreateSchemaBundleMetadata.properties.endTime (Total Keys: 2) - schemas.CreateSchemaBundleMetadata.properties.startTime (Total Keys: 2) - schemas.UpdateSchemaBundleMetadata.properties.endTime (Total Keys: 2) - schemas.UpdateSchemaBundleMetadata.properties.startTime (Total Keys: 2) The following keys were added: - resources.projects.resources.instances.methods.list.parameters.pageToken.deprecated (Total Keys: 1) - resources.projects.resources.instances.resources.clusters.methods.list.parameters.pageToken.deprecated (Total Keys: 1) - schemas.CreateBackupMetadata.properties.endTime.deprecated (Total Keys: 1) - schemas.CreateBackupMetadata.properties.finishTime (Total Keys: 2) - schemas.CreateBackupMetadata.properties.requestTime (Total Keys: 2) - schemas.CreateBackupMetadata.properties.startTime.deprecated (Total Keys: 1) - schemas.CreateLogicalViewMetadata.properties.endTime.deprecated (Total Keys: 1) - schemas.CreateLogicalViewMetadata.properties.finishTime (Total Keys: 2) - schemas.CreateLogicalViewMetadata.properties.requestTime (Total Keys: 2) - schemas.CreateLogicalViewMetadata.properties.startTime.deprecated (Total Keys: 1) - schemas.CreateMaterializedViewMetadata.properties.endTime.deprecated (Total Keys: 1) - schemas.CreateMaterializedViewMetadata.properties.finishTime (Total Keys: 2) - schemas.CreateMaterializedViewMetadata.properties.requestTime (Total Keys: 2) - schemas.CreateMaterializedViewMetadata.properties.startTime.deprecated (Total Keys: 1) - schemas.CreateSchemaBundleMetadata.properties.finishTime (Total Keys: 2) - schemas.CreateSchemaBundleMetadata.properties.requestTime (Total Keys: 2) - schemas.ListClustersResponse.properties.nextPageToken.deprecated (Total Keys: 1) - schemas.ListInstancesResponse.properties.nextPageToken.deprecated (Total Keys: 1) - schemas.UndeleteTableMetadata.properties.endTime.deprecated (Total Keys: 1) - schemas.UndeleteTableMetadata.properties.finishTime (Total Keys: 2) - schemas.UndeleteTableMetadata.properties.requestTime (Total Keys: 2) - schemas.UndeleteTableMetadata.properties.startTime.deprecated (Total Keys: 1) - schemas.UpdateLogicalViewMetadata.properties.endTime.deprecated (Total Keys: 1) - schemas.UpdateLogicalViewMetadata.properties.finishTime (Total Keys: 2) - schemas.UpdateLogicalViewMetadata.properties.requestTime (Total Keys: 2) - schemas.UpdateLogicalViewMetadata.properties.startTime.deprecated (Total Keys: 1) - schemas.UpdateSchemaBundleMetadata.properties.finishTime (Total Keys: 2) - schemas.UpdateSchemaBundleMetadata.properties.requestTime (Total Keys: 2) - schemas.UpdateTableMetadata.properties.endTime.deprecated (Total Keys: 1) - schemas.UpdateTableMetadata.properties.finishTime (Total Keys: 2) - schemas.UpdateTableMetadata.properties.requestTime (Total Keys: 2) - schemas.UpdateTableMetadata.properties.startTime.deprecated (Total Keys: 1) --- ...bleadmin_v2.projects.instances.tables.html | 164 +++++++++--------- .../bigtableadmin_v2.projects.locations.html | 2 +- .../documents/bigtableadmin.v2.json | 132 +++++++++++--- 3 files changed, 187 insertions(+), 111 deletions(-) diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index 52089d0dafc..bac6ce23031 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -232,7 +232,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -253,7 +253,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -273,7 +273,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -293,7 +293,7 @@

Method Details

"stringType": { # String Values of type `String` are stored in `Value.string_value`. # String "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. - "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. . + "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. . }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -301,12 +301,12 @@

Method Details

}, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -323,7 +323,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -351,12 +351,12 @@

Method Details

}, "rowKeySchema": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # The row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API. For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encoding. Queries that reference key fields will fail if they encounter an invalid row key. For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the following schema: { fields { field_name: "id" type { string { encoding: utf8_bytes {} } } } fields { field_name: "date" type { string { encoding: utf8_bytes {} } } } fields { field_name: "product_code" type { int64 { encoding: big_endian_bytes {} } } } encoding { delimited_bytes { delimiter: "#" } } } The decoded key parts would be: id = "some_id", date = "2024-04-30", product_code = 1245427 The query "SELECT _key, product_code FROM table" will return two columns: /------------------------------------------------------\ | _key | product_code | | --------------------------------------|--------------| | "some_id#2024-04-30#\x00\x13\x00\xf3" | 1245427 | \------------------------------------------------------/ The schema has the following invariants: (1) The decoded field values are order-preserved. For read, the field values will be decoded in sorted mode from the raw bytes. (2) Every field in the schema must specify a non-empty name. (3) Every field must specify a type with an associated encoding. The type is limited to scalar types only: Array, Map, Aggregate, and Struct are not allowed. (4) The field names must not collide with existing column family names and reserved keywords "_key" and "_timestamp". The following update operations are allowed for row_key_schema: - Update from an empty schema to a new schema. - Remove the existing schema. This operation requires setting the `ignore_warnings` flag to `true`, since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -438,7 +438,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -459,7 +459,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -479,7 +479,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -499,7 +499,7 @@

Method Details

"stringType": { # String Values of type `String` are stored in `Value.string_value`. # String "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. - "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. . + "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. . }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -507,12 +507,12 @@

Method Details

}, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -529,7 +529,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -557,12 +557,12 @@

Method Details

}, "rowKeySchema": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # The row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API. For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encoding. Queries that reference key fields will fail if they encounter an invalid row key. For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the following schema: { fields { field_name: "id" type { string { encoding: utf8_bytes {} } } } fields { field_name: "date" type { string { encoding: utf8_bytes {} } } } fields { field_name: "product_code" type { int64 { encoding: big_endian_bytes {} } } } encoding { delimited_bytes { delimiter: "#" } } } The decoded key parts would be: id = "some_id", date = "2024-04-30", product_code = 1245427 The query "SELECT _key, product_code FROM table" will return two columns: /------------------------------------------------------\ | _key | product_code | | --------------------------------------|--------------| | "some_id#2024-04-30#\x00\x13\x00\xf3" | 1245427 | \------------------------------------------------------/ The schema has the following invariants: (1) The decoded field values are order-preserved. For read, the field values will be decoded in sorted mode from the raw bytes. (2) Every field in the schema must specify a non-empty name. (3) Every field must specify a type with an associated encoding. The type is limited to scalar types only: Array, Map, Aggregate, and Struct are not allowed. (4) The field names must not collide with existing column family names and reserved keywords "_key" and "_timestamp". The following update operations are allowed for row_key_schema: - Update from an empty schema to a new schema. - Remove the existing schema. This operation requires setting the `ignore_warnings` flag to `true`, since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -727,7 +727,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -748,7 +748,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -768,7 +768,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -788,7 +788,7 @@

Method Details

"stringType": { # String Values of type `String` are stored in `Value.string_value`. # String "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. - "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. . + "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. . }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -796,12 +796,12 @@

Method Details

}, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -818,7 +818,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -846,12 +846,12 @@

Method Details

}, "rowKeySchema": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # The row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API. For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encoding. Queries that reference key fields will fail if they encounter an invalid row key. For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the following schema: { fields { field_name: "id" type { string { encoding: utf8_bytes {} } } } fields { field_name: "date" type { string { encoding: utf8_bytes {} } } } fields { field_name: "product_code" type { int64 { encoding: big_endian_bytes {} } } } encoding { delimited_bytes { delimiter: "#" } } } The decoded key parts would be: id = "some_id", date = "2024-04-30", product_code = 1245427 The query "SELECT _key, product_code FROM table" will return two columns: /------------------------------------------------------\ | _key | product_code | | --------------------------------------|--------------| | "some_id#2024-04-30#\x00\x13\x00\xf3" | 1245427 | \------------------------------------------------------/ The schema has the following invariants: (1) The decoded field values are order-preserved. For read, the field values will be decoded in sorted mode from the raw bytes. (2) Every field in the schema must specify a non-empty name. (3) Every field must specify a type with an associated encoding. The type is limited to scalar types only: Array, Map, Aggregate, and Struct are not allowed. (4) The field names must not collide with existing column family names and reserved keywords "_key" and "_timestamp". The following update operations are allowed for row_key_schema: - Update from an empty schema to a new schema. - Remove the existing schema. This operation requires setting the `ignore_warnings` flag to `true`, since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -1008,7 +1008,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1029,7 +1029,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1049,7 +1049,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1069,7 +1069,7 @@

Method Details

"stringType": { # String Values of type `String` are stored in `Value.string_value`. # String "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. - "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. . + "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. . }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -1077,12 +1077,12 @@

Method Details

}, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -1099,7 +1099,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1127,12 +1127,12 @@

Method Details

}, "rowKeySchema": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # The row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API. For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encoding. Queries that reference key fields will fail if they encounter an invalid row key. For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the following schema: { fields { field_name: "id" type { string { encoding: utf8_bytes {} } } } fields { field_name: "date" type { string { encoding: utf8_bytes {} } } } fields { field_name: "product_code" type { int64 { encoding: big_endian_bytes {} } } } encoding { delimited_bytes { delimiter: "#" } } } The decoded key parts would be: id = "some_id", date = "2024-04-30", product_code = 1245427 The query "SELECT _key, product_code FROM table" will return two columns: /------------------------------------------------------\ | _key | product_code | | --------------------------------------|--------------| | "some_id#2024-04-30#\x00\x13\x00\xf3" | 1245427 | \------------------------------------------------------/ The schema has the following invariants: (1) The decoded field values are order-preserved. For read, the field values will be decoded in sorted mode from the raw bytes. (2) Every field in the schema must specify a non-empty name. (3) Every field must specify a type with an associated encoding. The type is limited to scalar types only: Array, Map, Aggregate, and Struct are not allowed. (4) The field names must not collide with existing column family names and reserved keywords "_key" and "_timestamp". The following update operations are allowed for row_key_schema: - Update from an empty schema to a new schema. - Remove the existing schema. This operation requires setting the `ignore_warnings` flag to `true`, since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -1205,7 +1205,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1226,7 +1226,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1246,7 +1246,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1266,7 +1266,7 @@

Method Details

"stringType": { # String Values of type `String` are stored in `Value.string_value`. # String "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. - "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. . + "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. . }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -1274,12 +1274,12 @@

Method Details

}, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -1296,7 +1296,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1330,7 +1330,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1351,7 +1351,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1371,7 +1371,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1391,7 +1391,7 @@

Method Details

"stringType": { # String Values of type `String` are stored in `Value.string_value`. # String "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. - "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. . + "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. . }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -1399,12 +1399,12 @@

Method Details

}, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -1421,7 +1421,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1495,7 +1495,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1516,7 +1516,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1536,7 +1536,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1556,7 +1556,7 @@

Method Details

"stringType": { # String Values of type `String` are stored in `Value.string_value`. # String "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. - "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. . + "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. . }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -1564,12 +1564,12 @@

Method Details

}, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -1586,7 +1586,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1614,12 +1614,12 @@

Method Details

}, "rowKeySchema": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # The row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API. For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encoding. Queries that reference key fields will fail if they encounter an invalid row key. For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the following schema: { fields { field_name: "id" type { string { encoding: utf8_bytes {} } } } fields { field_name: "date" type { string { encoding: utf8_bytes {} } } } fields { field_name: "product_code" type { int64 { encoding: big_endian_bytes {} } } } encoding { delimited_bytes { delimiter: "#" } } } The decoded key parts would be: id = "some_id", date = "2024-04-30", product_code = 1245427 The query "SELECT _key, product_code FROM table" will return two columns: /------------------------------------------------------\ | _key | product_code | | --------------------------------------|--------------| | "some_id#2024-04-30#\x00\x13\x00\xf3" | 1245427 | \------------------------------------------------------/ The schema has the following invariants: (1) The decoded field values are order-preserved. For read, the field values will be decoded in sorted mode from the raw bytes. (2) Every field in the schema must specify a non-empty name. (3) Every field must specify a type with an associated encoding. The type is limited to scalar types only: Array, Map, Aggregate, and Struct are not allowed. (4) The field names must not collide with existing column family names and reserved keywords "_key" and "_timestamp". The following update operations are allowed for row_key_schema: - Update from an empty schema to a new schema. - Remove the existing schema. This operation requires setting the `ignore_warnings` flag to `true`, since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -1701,7 +1701,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both "{'foo': '1', 'bar': '2'}" and "{'bar': '2', 'foo': '1'}" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001")`. # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes provide either the `input_type` or `state_type`, and reads always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1722,7 +1722,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Bytes "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1742,7 +1742,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1762,7 +1762,7 @@

Method Details

"stringType": { # String Values of type `String` are stored in `Value.string_value`. # String "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "utf8Bytes": { # UTF-8 encoding. Sorted mode: - All values are supported. - Code point order is preserved. Distinct mode: all values are supported. Compatible with: - BigQuery `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. - "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. . + "nullEscapeChar": "A String", # Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. . }, "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. }, @@ -1770,12 +1770,12 @@

Method Details

}, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. @@ -1792,7 +1792,7 @@

Method Details

"bytesType": { # Bytes Values of type `Bytes` are stored in `Value.bytes_value`. # Deprecated: ignored if set. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. "raw": { # Leaves the value as-is. Sorted mode: all values are supported. Distinct mode: all values are supported. # Use `Raw` encoding. - "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended. + "escapeNulls": True or False, # If set, allows NULL values to be encoded as the empty string "". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended. }, }, }, @@ -1820,12 +1820,12 @@

Method Details

}, "rowKeySchema": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # The row key schema for this table. The schema is used to decode the raw row key bytes into a structured format. The order of field declarations in this schema is important, as it reflects how the raw row key bytes are structured. Currently, this only affects how the key is read via a GoogleSQL query from the ExecuteQuery API. For a SQL query, the _key column is still read as raw bytes. But queries can reference the key fields by name, which will be decoded from _key using provided type and encoding. Queries that reference key fields will fail if they encounter an invalid row key. For example, if _key = "some_id#2024-04-30#\x00\x13\x00\xf3" with the following schema: { fields { field_name: "id" type { string { encoding: utf8_bytes {} } } } fields { field_name: "date" type { string { encoding: utf8_bytes {} } } } fields { field_name: "product_code" type { int64 { encoding: big_endian_bytes {} } } } encoding { delimited_bytes { delimiter: "#" } } } The decoded key parts would be: id = "some_id", date = "2024-04-30", product_code = 1245427 The query "SELECT _key, product_code FROM table" will return two columns: /------------------------------------------------------\ | _key | product_code | | --------------------------------------|--------------| | "some_id#2024-04-30#\x00\x13\x00\xf3" | 1245427 | \------------------------------------------------------/ The schema has the following invariants: (1) The decoded field values are order-preserved. For read, the field values will be decoded in sorted mode from the raw bytes. (2) Every field in the schema must specify a non-empty name. (3) Every field must specify a type with an associated encoding. The type is limited to scalar types only: Array, Map, Aggregate, and Struct are not allowed. (4) The field names must not collide with existing column family names and reserved keywords "_key" and "_timestamp". The following update operations are allowed for row_key_schema: - Update from an empty schema to a new schema. - Remove the existing schema. This operation requires setting the `ignore_warnings` flag to `true`, since it might be a backward incompatible change. Without the flag, the update request will fail with an INVALID_ARGUMENT error. Any other row key schema update operation (e.g. update existing schema columns names or types) is currently unsupported. "encoding": { # Rules used to convert to or from lower level types. # The encoding to use when converting to or from lower level types. - "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. + "delimitedBytes": { # Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`. # Use `DelimitedBytes` encoding. "delimiter": "A String", # Byte sequence used to delimit concatenated fields. The delimiter must contain at least 1 character and at most 50 characters. }, - "orderedCodeBytes": { # Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string "" have special handling: - If *every* field encodes to "", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. + "orderedCodeBytes": { # Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string "", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string "", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> "\00\00" - STRUCT("") -> "\00\00" - STRUCT("", "") -> "\00\00" - STRUCT("", "B") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "") -> "A" - STRUCT("", "B", "") -> "\00\00" + "\00\01" + "B" - STRUCT("A", "", "C") -> "A" + "\00\01" + "\00\00" + "\00\01" + "C" ``` Examples for struct with `DESC` fields: ``` - STRUCT("" DESC) -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "", "") -> "\xFF\xFF" + "\xFF\xFE" - STRUCT("" DESC, "A") -> "\xFF\xFF" + "\xFF\xFE" + "A" - STRUCT("A", "" DESC, "") -> "A" + "\00\01" + "\xFF\xFF" + "\xFF\xFE" - STRUCT("", "A" DESC) -> "\x00\x00" + "\x00\x01" + "\xBE" + "\xFF\xFE" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed. # User `OrderedCodeBytes` encoding. }, - "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. # Use `Singleton` encoding. + "singleton": { # Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering. # Use `Singleton` encoding. }, }, "fields": [ # The names and types of the fields in this struct. diff --git a/docs/dyn/bigtableadmin_v2.projects.locations.html b/docs/dyn/bigtableadmin_v2.projects.locations.html index 16b7c6335da..5d8d55bee83 100644 --- a/docs/dyn/bigtableadmin_v2.projects.locations.html +++ b/docs/dyn/bigtableadmin_v2.projects.locations.html @@ -95,7 +95,7 @@

Method Details

Args: name: string, The resource that owns the locations collection, if applicable. (required) - extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated) + extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated) filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). pageSize: integer, The maximum number of results to return. If not set, the service selects a default. pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index 8033a6a605d..20405cad8c6 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -362,6 +362,7 @@ ], "parameters": { "pageToken": { +"deprecated": true, "description": "DEPRECATED: This field is unused and ignored.", "location": "query", "type": "string" @@ -837,6 +838,7 @@ ], "parameters": { "pageToken": { +"deprecated": true, "description": "DEPRECATED: This field is unused and ignored.", "location": "query", "type": "string" @@ -3029,7 +3031,7 @@ ], "parameters": { "extraLocationTypes": { -"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", +"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -3077,7 +3079,7 @@ } } }, -"revision": "20250828", +"revision": "20250912", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -3697,7 +3699,13 @@ "id": "CreateBackupMetadata", "properties": { "endTime": { -"description": "If set, the time at which this operation finished or was cancelled.", +"deprecated": true, +"description": "If set, the time at which this operation finished or was cancelled. DEPRECATED: Use finish_time instead.", +"format": "google-datetime", +"type": "string" +}, +"finishTime": { +"description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -3705,12 +3713,18 @@ "description": "The name of the backup being created.", "type": "string" }, +"requestTime": { +"description": "The time at which the original request was received.", +"format": "google-datetime", +"type": "string" +}, "sourceTable": { "description": "The name of the table the backup is created from.", "type": "string" }, "startTime": { -"description": "The time at which this operation started.", +"deprecated": true, +"description": "The time at which this operation started. DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } @@ -3816,7 +3830,13 @@ "id": "CreateLogicalViewMetadata", "properties": { "endTime": { -"description": "If set, the time at which this operation finished or was canceled.", +"deprecated": true, +"description": "DEPRECATED: Use finish_time instead.", +"format": "google-datetime", +"type": "string" +}, +"finishTime": { +"description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -3824,8 +3844,14 @@ "$ref": "CreateLogicalViewRequest", "description": "The request that prompted the initiation of this CreateLogicalView operation." }, +"requestTime": { +"description": "The time at which the original request was received.", +"format": "google-datetime", +"type": "string" +}, "startTime": { -"description": "The time at which this operation started.", +"deprecated": true, +"description": "DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } @@ -3856,7 +3882,13 @@ "id": "CreateMaterializedViewMetadata", "properties": { "endTime": { -"description": "If set, the time at which this operation finished or was canceled.", +"deprecated": true, +"description": "If set, the time at which this operation finished or was canceled. DEPRECATED: Use finish_time instead.", +"format": "google-datetime", +"type": "string" +}, +"finishTime": { +"description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -3864,8 +3896,14 @@ "$ref": "CreateMaterializedViewRequest", "description": "The request that prompted the initiation of this CreateMaterializedView operation." }, +"requestTime": { +"description": "The time at which the original request was received.", +"format": "google-datetime", +"type": "string" +}, "startTime": { -"description": "The time at which this operation started.", +"deprecated": true, +"description": "The time at which this operation started. DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } @@ -3895,8 +3933,8 @@ "description": "The metadata for the Operation returned by CreateSchemaBundle.", "id": "CreateSchemaBundleMetadata", "properties": { -"endTime": { -"description": "If set, the time at which this operation finished or was canceled.", +"finishTime": { +"description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -3904,8 +3942,8 @@ "description": "The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`", "type": "string" }, -"startTime": { -"description": "The time at which this operation started.", +"requestTime": { +"description": "The time at which the original request was received.", "format": "google-datetime", "type": "string" } @@ -4257,7 +4295,7 @@ "id": "GoogleBigtableAdminV2TypeBytesEncodingRaw", "properties": { "escapeNulls": { -"description": "If set, allows NULL values to be encoded as the empty string \"\". The actual empty string, or any value which only contains the null byte 0x00, has one more null byte appended.", +"description": "If set, allows NULL values to be encoded as the empty string \"\". The actual empty string, or any value which only contains the null byte `0x00`, has one more null byte appended.", "type": "boolean" } }, @@ -4402,7 +4440,7 @@ "id": "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes", "properties": { "nullEscapeChar": { -"description": "Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string \"\". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character 0x00, then the encoding will not support sorted mode. .", +"description": "Single-character escape sequence used to support NULL values. If set, allows NULL values to be encoded as the empty string \"\". The actual empty string, or any value where every character equals `null_escape_char`, has one more `null_escape_char` appended. If `null_escape_char` is set and does not equal the ASCII null character `0x00`, then the encoding will not support sorted mode. .", "type": "string" } }, @@ -4453,7 +4491,7 @@ "type": "object" }, "GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes": { -"description": "Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`.", +"description": "Fields are encoded independently and concatenated with a configurable `delimiter` in between. A struct with no fields defined is encoded as a single `delimiter`. Sorted mode: - Fields are encoded in sorted mode. - Encoded field values must not contain any bytes <= `delimiter[0]` - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. - This encoding does not support `DESC` field ordering. Distinct mode: - Fields are encoded in distinct mode. - Encoded field values must not contain `delimiter[0]`.", "id": "GoogleBigtableAdminV2TypeStructEncodingDelimitedBytes", "properties": { "delimiter": { @@ -4465,13 +4503,13 @@ "type": "object" }, "GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes": { -"description": "Fields are encoded independently and concatenated with the fixed byte pair {0x00, 0x01} in between. Any null (0x00) byte in an encoded field is replaced by the fixed byte pair {0x00, 0xFF}. Fields that encode to the empty string \"\" have special handling: - If *every* field encodes to \"\", or if the STRUCT has no fields defined, then the STRUCT is encoded as the fixed byte pair {0x00, 0x00}. - Otherwise, the STRUCT only encodes until the last non-empty field, omitting any trailing empty fields. Any empty fields that aren't omitted are replaced with the fixed byte pair {0x00, 0x00}. Examples: - STRUCT() -> \"\\00\\00\" - STRUCT(\"\") -> \"\\00\\00\" - STRUCT(\"\", \"\") -> \"\\00\\00\" - STRUCT(\"\", \"B\") -> \"\\00\\00\" + \"\\00\\01\" + \"B\" - STRUCT(\"A\", \"\") -> \"A\" - STRUCT(\"\", \"B\", \"\") -> \"\\00\\00\" + \"\\00\\01\" + \"B\" - STRUCT(\"A\", \"\", \"C\") -> \"A\" + \"\\00\\01\" + \"\\00\\00\" + \"\\00\\01\" + \"C\" Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed.", +"description": "Fields are encoded independently, then escaped and delimited by appling the following rules in order: - While the last remaining field is `ASC` or `UNSPECIFIED`, and encodes to the empty string \"\", remove it. - In each remaining field, replace all null bytes `0x00` with the fixed byte pair `{0x00, 0xFF}`. - If any remaining field encodes to the empty string \"\", replace it with the fixed byte pair `{0x00, 0x00}`. - Append the fixed byte pair `{0x00, 0x01}` to each remaining field, except for the last remaining field if it is `ASC`. - Bitwise negate all `DESC` fields. - Concatenate the results, or emit the fixed byte pair `{0x00, 0x00}` if there are no remaining fields to concatenate. Examples: ``` - STRUCT() -> \"\\00\\00\" - STRUCT(\"\") -> \"\\00\\00\" - STRUCT(\"\", \"\") -> \"\\00\\00\" - STRUCT(\"\", \"B\") -> \"\\00\\00\" + \"\\00\\01\" + \"B\" - STRUCT(\"A\", \"\") -> \"A\" - STRUCT(\"\", \"B\", \"\") -> \"\\00\\00\" + \"\\00\\01\" + \"B\" - STRUCT(\"A\", \"\", \"C\") -> \"A\" + \"\\00\\01\" + \"\\00\\00\" + \"\\00\\01\" + \"C\" ``` Examples for struct with `DESC` fields: ``` - STRUCT(\"\" DESC) -> \"\\xFF\\xFF\" + \"\\xFF\\xFE\" - STRUCT(\"\" DESC, \"\") -> \"\\xFF\\xFF\" + \"\\xFF\\xFE\" - STRUCT(\"\" DESC, \"\", \"\") -> \"\\xFF\\xFF\" + \"\\xFF\\xFE\" - STRUCT(\"\" DESC, \"A\") -> \"\\xFF\\xFF\" + \"\\xFF\\xFE\" + \"A\" - STRUCT(\"A\", \"\" DESC, \"\") -> \"A\" + \"\\00\\01\" + \"\\xFF\\xFF\" + \"\\xFF\\xFE\" - STRUCT(\"\", \"A\" DESC) -> \"\\x00\\x00\" + \"\\x00\\x01\" + \"\\xBE\" + \"\\xFF\\xFE\" ``` Since null bytes are always escaped, this encoding can cause size blowup for encodings like `Int64.BigEndianBytes` that are likely to produce many such bytes. Sorted mode: - Fields are encoded in sorted mode. - All values supported by the field encodings are allowed. - Fields with unset or `UNSPECIFIED` order are treated as `ASC`. - Element-wise order is preserved: `A < B` if `A[0] < B[0]`, or if `A[0] == B[0] && A[1] < B[1]`, etc. Strict prefixes sort first. Distinct mode: - Fields are encoded in distinct mode. - All values supported by the field encodings are allowed.", "id": "GoogleBigtableAdminV2TypeStructEncodingOrderedCodeBytes", "properties": {}, "type": "object" }, "GoogleBigtableAdminV2TypeStructEncodingSingleton": { -"description": "Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`.", +"description": "Uses the encoding of `fields[0].type` as-is. Only valid if `fields.size == 1`. This encoding does not support `DESC` field ordering.", "id": "GoogleBigtableAdminV2TypeStructEncodingSingleton", "properties": {}, "type": "object" @@ -4722,6 +4760,7 @@ "type": "array" }, "nextPageToken": { +"deprecated": true, "description": "DEPRECATED: This field is unused and ignored.", "type": "string" } @@ -4765,6 +4804,7 @@ "type": "array" }, "nextPageToken": { +"deprecated": true, "description": "DEPRECATED: This field is unused and ignored.", "type": "string" } @@ -5568,7 +5608,7 @@ "type": "object" }, "Type": { -"description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both \"{'foo': '1', 'bar': '2'}\" and \"{'bar': '2', 'foo': '1'}\" are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING(\"-00001\") > STRING(\"00001\")`.", +"description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to or from the underlying data. Each encoding can operate in one of two modes: - Sorted: In this mode, Bigtable guarantees that `Encode(X) <= Encode(Y)` if and only if `X <= Y`. This is useful anywhere sort order is important, for example when encoding keys. - Distinct: In this mode, Bigtable guarantees that if `X != Y` then `Encode(X) != Encode(Y)`. However, the converse is not guaranteed. For example, both `{'foo': '1', 'bar': '2'}` and `{'bar': '2', 'foo': '1'}` are valid encodings of the same JSON value. The API clearly documents which mode is used wherever an encoding can be configured. Each encoding also documents which values are supported in which modes. For example, when encoding INT64 as a numeric STRING, negative numbers cannot be encoded in sorted mode. This is because `INT64(1) > INT64(-1)`, but `STRING(\"-00001\") > STRING(\"00001\")`.", "id": "Type", "properties": { "aggregateType": { @@ -5635,7 +5675,13 @@ "id": "UndeleteTableMetadata", "properties": { "endTime": { -"description": "If set, the time at which this operation finished or was cancelled.", +"deprecated": true, +"description": "If set, the time at which this operation finished or was cancelled. DEPRECATED: Use finish_time instead.", +"format": "google-datetime", +"type": "string" +}, +"finishTime": { +"description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -5643,8 +5689,14 @@ "description": "The name of the table being restored.", "type": "string" }, +"requestTime": { +"description": "The time at which the original request was received.", +"format": "google-datetime", +"type": "string" +}, "startTime": { -"description": "The time at which this operation started.", +"deprecated": true, +"description": "The time at which this operation started. DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } @@ -5765,7 +5817,13 @@ "id": "UpdateLogicalViewMetadata", "properties": { "endTime": { -"description": "If set, the time at which this operation finished or was canceled.", +"deprecated": true, +"description": "DEPRECATED: Use finish_time instead.", +"format": "google-datetime", +"type": "string" +}, +"finishTime": { +"description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -5773,8 +5831,14 @@ "$ref": "UpdateLogicalViewRequest", "description": "The request that prompted the initiation of this UpdateLogicalView operation." }, +"requestTime": { +"description": "The time at which the original request was received.", +"format": "google-datetime", +"type": "string" +}, "startTime": { -"description": "The time at which this operation was started.", +"deprecated": true, +"description": "DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } @@ -5801,8 +5865,8 @@ "description": "The metadata for the Operation returned by UpdateSchemaBundle.", "id": "UpdateSchemaBundleMetadata", "properties": { -"endTime": { -"description": "If set, the time at which this operation finished or was canceled.", +"finishTime": { +"description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -5810,8 +5874,8 @@ "description": "The unique name identifying this schema bundle. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/schemaBundles/{schema_bundle}`", "type": "string" }, -"startTime": { -"description": "The time at which this operation started.", +"requestTime": { +"description": "The time at which the original request was received.", "format": "google-datetime", "type": "string" } @@ -5823,7 +5887,13 @@ "id": "UpdateTableMetadata", "properties": { "endTime": { -"description": "If set, the time at which this operation finished or was canceled.", +"deprecated": true, +"description": "If set, the time at which this operation finished or was canceled. DEPRECATED: Use finish_time instead.", +"format": "google-datetime", +"type": "string" +}, +"finishTime": { +"description": "The time at which the operation failed or was completed successfully.", "format": "google-datetime", "type": "string" }, @@ -5831,8 +5901,14 @@ "description": "The name of the table being updated.", "type": "string" }, +"requestTime": { +"description": "The time at which the original request was received.", +"format": "google-datetime", +"type": "string" +}, "startTime": { -"description": "The time at which this operation started.", +"deprecated": true, +"description": "The time at which this operation started. DEPRECATED: Use request_time instead.", "format": "google-datetime", "type": "string" } From ccc9bde48e5128aa1cfe4b3559791f24a7feec1e Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 23 Sep 2025 07:09:07 +0000 Subject: [PATCH 05/26] feat(chat): update the api #### chat:v1 The following keys were added: - schemas.GoogleAppsCardV1DecoratedText.properties.bottomLabelText.$ref (Total Keys: 1) - schemas.GoogleAppsCardV1DecoratedText.properties.contentText.$ref (Total Keys: 1) - schemas.GoogleAppsCardV1DecoratedText.properties.startIconVerticalAlignment.type (Total Keys: 1) - schemas.GoogleAppsCardV1DecoratedText.properties.topLabelText.$ref (Total Keys: 1) - schemas.GoogleAppsCardV1TextParagraph.properties.textSyntax.type (Total Keys: 1) --- docs/dyn/chat_v1.spaces.messages.html | 1056 ++++++++++- docs/dyn/chat_v1.spaces.spaceEvents.html | 1584 +++++++++++++++-- .../discovery_cache/documents/chat.v1.json | 50 +- 3 files changed, 2446 insertions(+), 244 deletions(-) diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 1412542b19e..8ab69b0c9d2 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -237,11 +237,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -251,11 +251,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -265,6 +266,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -364,7 +366,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -402,6 +414,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -426,6 +439,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -595,6 +613,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -637,7 +656,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -675,6 +704,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -699,6 +729,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -928,6 +963,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -1063,11 +1099,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -1077,11 +1113,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -1091,6 +1128,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -1190,7 +1228,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -1228,6 +1276,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -1252,6 +1301,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -1421,6 +1475,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -1463,7 +1518,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -1501,6 +1566,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -1525,6 +1591,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -1754,6 +1825,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -2102,11 +2174,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -2116,11 +2188,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -2130,6 +2203,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -2229,7 +2303,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -2267,6 +2351,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -2291,6 +2376,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -2460,6 +2550,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -2502,7 +2593,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -2540,6 +2641,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -2564,6 +2666,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -2793,6 +2900,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -3058,11 +3166,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -3072,11 +3180,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -3086,6 +3195,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -3185,7 +3295,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -3223,6 +3343,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -3247,6 +3368,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -3416,6 +3542,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -3458,7 +3585,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -3496,6 +3633,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -3520,6 +3658,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -3749,6 +3892,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -3884,11 +4028,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -3898,11 +4042,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -3912,6 +4057,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -4011,7 +4157,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -4049,6 +4205,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -4073,6 +4230,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -4242,6 +4404,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -4284,7 +4447,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -4322,6 +4495,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -4346,6 +4520,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -4575,6 +4754,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -4923,11 +5103,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -4937,11 +5117,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -4951,6 +5132,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -5050,7 +5232,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -5088,6 +5280,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -5112,6 +5305,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -5281,6 +5479,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -5323,7 +5522,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -5361,6 +5570,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -5385,6 +5595,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -5614,6 +5829,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -5897,11 +6113,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -5911,11 +6127,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -5925,6 +6142,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -6024,7 +6242,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -6062,6 +6290,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -6086,6 +6315,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -6255,6 +6489,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -6297,7 +6532,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -6335,6 +6580,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -6359,6 +6605,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -6588,6 +6839,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -6723,11 +6975,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -6737,11 +6989,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -6751,6 +7004,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -6850,7 +7104,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -6888,6 +7152,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -6912,6 +7177,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -7081,6 +7351,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -7123,7 +7394,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -7161,6 +7442,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -7185,6 +7467,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -7414,6 +7701,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -7762,11 +8050,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -7776,11 +8064,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -7790,6 +8079,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -7889,7 +8179,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -7927,6 +8227,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -7951,6 +8252,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -8120,6 +8426,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -8162,7 +8469,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -8200,6 +8517,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -8224,6 +8542,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -8453,6 +8776,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -8724,11 +9048,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -8738,11 +9062,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -8752,6 +9077,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -8851,7 +9177,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -8889,6 +9225,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -8913,6 +9250,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -9082,6 +9424,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -9124,7 +9467,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -9162,6 +9515,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -9186,6 +9540,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -9415,6 +9774,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -9550,11 +9910,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -9564,11 +9924,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -9578,6 +9939,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -9677,7 +10039,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -9715,6 +10087,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -9739,6 +10112,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -9908,6 +10286,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -9950,7 +10329,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -9988,6 +10377,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -10012,6 +10402,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -10241,6 +10636,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -10589,11 +10985,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -10603,11 +10999,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -10617,6 +11014,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -10716,7 +11114,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -10754,6 +11162,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -10778,6 +11187,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -10947,6 +11361,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -10989,7 +11404,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -11027,6 +11452,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -11051,6 +11477,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -11280,6 +11711,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -11556,11 +11988,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -11570,11 +12002,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -11584,6 +12017,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -11683,7 +12117,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -11721,6 +12165,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -11745,6 +12190,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -11914,6 +12364,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -11956,7 +12407,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -11994,6 +12455,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -12018,6 +12480,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -12247,6 +12714,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -12382,11 +12850,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -12396,11 +12864,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -12410,6 +12879,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -12509,7 +12979,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -12547,6 +13027,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -12571,6 +13052,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -12740,6 +13226,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -12782,7 +13269,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -12820,6 +13317,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -12844,6 +13342,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -13073,6 +13576,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -13421,11 +13925,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -13435,11 +13939,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -13449,6 +13954,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -13548,7 +14054,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -13586,6 +14102,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -13610,6 +14127,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -13779,6 +14301,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -13821,7 +14344,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -13859,6 +14392,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -13883,6 +14417,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -14112,6 +14651,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -14371,11 +14911,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -14385,11 +14925,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -14399,6 +14940,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -14498,7 +15040,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -14536,6 +15088,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -14560,6 +15113,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -14729,6 +15287,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -14771,7 +15330,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -14809,6 +15378,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -14833,6 +15403,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -15062,6 +15637,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -15197,11 +15773,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -15211,11 +15787,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -15225,6 +15802,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -15324,7 +15902,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -15362,6 +15950,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -15386,6 +15975,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -15555,6 +16149,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -15597,7 +16192,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -15635,6 +16240,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -15659,6 +16265,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -15888,6 +16499,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -16236,11 +16848,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -16250,11 +16862,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -16264,6 +16877,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -16363,7 +16977,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -16401,6 +17025,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -16425,6 +17050,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -16594,6 +17224,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -16636,7 +17267,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -16674,6 +17315,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -16698,6 +17340,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -16927,6 +17574,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -17186,11 +17834,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -17200,11 +17848,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -17214,6 +17863,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -17313,7 +17963,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -17351,6 +18011,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -17375,6 +18036,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -17544,6 +18210,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -17586,7 +18253,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -17624,6 +18301,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -17648,6 +18326,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -17877,6 +18560,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -18012,11 +18696,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -18026,11 +18710,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -18040,6 +18725,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -18139,7 +18825,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -18177,6 +18873,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -18201,6 +18898,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -18370,6 +19072,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -18412,7 +19115,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -18450,6 +19163,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -18474,6 +19188,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -18703,6 +19422,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -19051,11 +19771,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -19065,11 +19785,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -19079,6 +19800,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -19178,7 +19900,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -19216,6 +19948,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -19240,6 +19973,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -19409,6 +20147,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -19451,7 +20190,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -19489,6 +20238,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -19513,6 +20263,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -19742,6 +20497,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -20001,11 +20757,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -20015,11 +20771,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -20029,6 +20786,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -20128,7 +20886,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -20166,6 +20934,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -20190,6 +20959,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -20359,6 +21133,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -20401,7 +21176,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -20439,6 +21224,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -20463,6 +21249,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -20692,6 +21483,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -20827,11 +21619,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -20841,11 +21633,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -20855,6 +21648,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -20954,7 +21748,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -20992,6 +21796,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -21016,6 +21821,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -21185,6 +21995,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -21227,7 +22038,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -21265,6 +22086,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -21289,6 +22111,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -21518,6 +22345,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -21866,11 +22694,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -21880,11 +22708,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -21894,6 +22723,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -21993,7 +22823,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -22031,6 +22871,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -22055,6 +22896,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -22224,6 +23070,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -22266,7 +23113,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -22304,6 +23161,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -22328,6 +23186,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -22557,6 +23420,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index b7c9bbd2ce8..b55e2ffd035 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -352,11 +352,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -366,11 +366,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -380,6 +381,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -479,7 +481,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -517,6 +529,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -541,6 +554,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -710,6 +728,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -752,7 +771,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -790,6 +819,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -814,6 +844,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -1043,6 +1078,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -1178,11 +1214,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -1192,11 +1228,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -1206,6 +1243,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -1305,7 +1343,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -1343,6 +1391,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -1367,6 +1416,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -1536,6 +1590,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -1578,7 +1633,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -1616,6 +1681,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -1640,6 +1706,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -1869,6 +1940,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -2217,11 +2289,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -2231,11 +2303,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -2245,6 +2318,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -2344,7 +2418,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -2382,6 +2466,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -2406,6 +2491,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -2575,6 +2665,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -2617,7 +2708,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -2655,6 +2756,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -2679,6 +2781,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -2908,6 +3015,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -3162,11 +3270,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -3176,11 +3284,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -3190,6 +3299,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -3289,7 +3399,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -3327,6 +3447,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -3351,6 +3472,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -3520,6 +3646,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -3562,7 +3689,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -3600,6 +3737,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -3624,6 +3762,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -3853,6 +3996,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -3988,11 +4132,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -4002,11 +4146,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -4016,6 +4161,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -4115,7 +4261,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -4153,6 +4309,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -4177,6 +4334,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -4346,6 +4508,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -4388,7 +4551,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -4426,6 +4599,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -4450,6 +4624,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -4679,6 +4858,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -5027,11 +5207,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -5041,11 +5221,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -5055,6 +5236,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -5154,7 +5336,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -5192,6 +5384,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -5216,6 +5409,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -5385,6 +5583,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -5427,7 +5626,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -5465,6 +5674,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -5489,6 +5699,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -5718,6 +5933,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -5972,11 +6188,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -5986,11 +6202,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -6000,6 +6217,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -6099,7 +6317,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -6137,6 +6365,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -6161,6 +6390,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -6330,6 +6564,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -6372,7 +6607,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -6410,6 +6655,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -6434,6 +6680,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -6663,6 +6914,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -6798,11 +7050,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -6812,11 +7064,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -6826,6 +7079,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -6925,7 +7179,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -6963,6 +7227,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -6987,6 +7252,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -7156,6 +7426,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -7198,7 +7469,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -7236,6 +7517,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -7260,6 +7542,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -7489,6 +7776,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -7837,11 +8125,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -7851,11 +8139,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -7865,6 +8154,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -7964,7 +8254,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -8002,6 +8302,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -8026,6 +8327,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -8195,6 +8501,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -8237,7 +8544,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -8275,6 +8592,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -8299,6 +8617,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -8528,6 +8851,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -8780,11 +9104,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -8794,11 +9118,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -8808,6 +9133,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -8907,7 +9233,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -8945,6 +9281,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -8969,6 +9306,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -9138,6 +9480,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -9180,7 +9523,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -9218,6 +9571,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -9242,6 +9596,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -9471,6 +9830,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -9606,11 +9966,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -9620,11 +9980,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -9634,6 +9995,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -9733,7 +10095,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -9771,6 +10143,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -9795,6 +10168,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -9964,6 +10342,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -10006,7 +10385,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -10044,6 +10433,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -10068,6 +10458,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -10297,6 +10692,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -10645,11 +11041,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -10659,11 +11055,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -10673,6 +11070,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -10772,7 +11170,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -10810,6 +11218,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -10834,6 +11243,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -11003,6 +11417,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -11045,7 +11460,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -11083,6 +11508,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -11107,6 +11533,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -11336,6 +11767,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -11586,11 +12018,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -11600,11 +12032,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -11614,6 +12047,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -11713,7 +12147,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -11751,6 +12195,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -11775,6 +12220,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -11944,6 +12394,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -11986,7 +12437,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -12024,6 +12485,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -12048,6 +12510,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -12277,6 +12744,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -12412,11 +12880,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -12426,11 +12894,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -12440,6 +12909,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -12539,7 +13009,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -12577,6 +13057,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -12601,6 +13082,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -12770,6 +13256,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -12812,7 +13299,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -12850,6 +13347,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -12874,6 +13372,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -13103,6 +13606,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -13451,11 +13955,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -13465,11 +13969,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -13479,6 +13984,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -13578,7 +14084,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -13616,6 +14132,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -13640,6 +14157,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -13809,6 +14331,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -13851,7 +14374,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -13889,6 +14422,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -13913,6 +14447,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -14142,6 +14681,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -14392,11 +14932,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -14406,11 +14946,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -14420,6 +14961,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -14519,7 +15061,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -14557,6 +15109,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -14581,6 +15134,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -14750,6 +15308,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -14792,7 +15351,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -14830,6 +15399,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -14854,6 +15424,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -15083,6 +15658,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -15218,11 +15794,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -15232,11 +15808,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -15246,6 +15823,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -15345,7 +15923,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -15383,6 +15971,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -15407,6 +15996,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -15576,6 +16170,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -15618,7 +16213,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -15656,6 +16261,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -15680,6 +16286,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -15909,6 +16520,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -16257,11 +16869,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -16271,11 +16883,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -16285,6 +16898,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -16384,7 +16998,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -16422,6 +17046,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -16446,6 +17071,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -16615,6 +17245,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -16657,7 +17288,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -16695,6 +17336,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -16719,6 +17361,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -16948,6 +17595,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -17599,11 +18247,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -17613,11 +18261,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -17627,6 +18276,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -17726,7 +18376,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -17764,6 +18424,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -17788,6 +18449,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -17957,6 +18623,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -17999,7 +18666,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -18037,6 +18714,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -18061,6 +18739,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -18290,6 +18973,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -18425,11 +19109,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -18439,11 +19123,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -18453,6 +19138,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -18552,7 +19238,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -18590,6 +19286,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -18614,6 +19311,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -18783,6 +19485,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -18825,7 +19528,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -18863,6 +19576,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -18887,6 +19601,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -19116,6 +19835,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -19464,11 +20184,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -19478,11 +20198,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -19492,6 +20213,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -19591,7 +20313,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -19629,6 +20361,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -19653,6 +20386,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -19822,6 +20560,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -19864,7 +20603,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -19902,6 +20651,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -19926,6 +20676,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -20155,6 +20910,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -20409,11 +21165,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -20423,11 +21179,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -20437,6 +21194,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -20536,7 +21294,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -20574,6 +21342,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -20598,6 +21367,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -20767,6 +21541,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -20809,7 +21584,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -20847,6 +21632,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -20871,6 +21657,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -21100,6 +21891,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -21235,11 +22027,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -21249,11 +22041,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -21263,6 +22056,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -21362,7 +22156,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -21400,6 +22204,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -21424,6 +22229,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -21593,6 +22403,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -21635,7 +22446,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -21673,6 +22494,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -21697,6 +22519,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -21926,6 +22753,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -22274,11 +23102,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -22288,11 +23116,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -22302,6 +23131,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -22401,7 +23231,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -22439,6 +23279,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -22463,6 +23304,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -22632,6 +23478,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -22674,7 +23521,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -22712,6 +23569,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -22736,6 +23594,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -22965,6 +23828,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -23219,11 +24083,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -23233,11 +24097,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -23247,6 +24112,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -23346,7 +24212,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -23384,6 +24260,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -23408,6 +24285,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -23577,6 +24459,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -23619,7 +24502,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -23657,6 +24550,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -23681,6 +24575,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -23910,6 +24809,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -24045,11 +24945,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -24059,11 +24959,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -24073,6 +24974,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -24172,7 +25074,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -24210,6 +25122,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -24234,6 +25147,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -24403,6 +25321,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -24445,7 +25364,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -24483,6 +25412,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -24507,6 +25437,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -24736,6 +25671,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -25084,11 +26020,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -25098,11 +26034,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -25112,6 +26049,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -25211,7 +26149,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -25249,6 +26197,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -25273,6 +26222,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -25442,6 +26396,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -25484,7 +26439,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -25522,6 +26487,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -25546,6 +26512,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -25775,6 +26746,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -26027,11 +26999,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -26041,11 +27013,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -26055,6 +27028,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -26154,7 +27128,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -26192,6 +27176,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -26216,6 +27201,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -26385,6 +27375,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -26427,7 +27418,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -26465,6 +27466,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -26489,6 +27491,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -26718,6 +27725,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -26853,11 +27861,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -26867,11 +27875,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -26881,6 +27890,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -26980,7 +27990,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -27018,6 +28038,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -27042,6 +28063,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -27211,6 +28237,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -27253,7 +28280,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -27291,6 +28328,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -27315,6 +28353,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -27544,6 +28587,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -27892,11 +28936,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -27906,11 +28950,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -27920,6 +28965,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -28019,7 +29065,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -28057,6 +29113,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -28081,6 +29138,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -28250,6 +29312,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -28292,7 +29355,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -28330,6 +29403,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -28354,6 +29428,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -28583,6 +29662,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -28833,11 +29913,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -28847,11 +29927,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -28861,6 +29942,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -28960,7 +30042,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -28998,6 +30090,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -29022,6 +30115,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -29191,6 +30289,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -29233,7 +30332,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -29271,6 +30380,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -29295,6 +30405,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -29524,6 +30639,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -29659,11 +30775,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -29673,11 +30789,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -29687,6 +30804,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -29786,7 +30904,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -29824,6 +30952,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -29848,6 +30977,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -30017,6 +31151,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -30059,7 +31194,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -30097,6 +31242,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -30121,6 +31267,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -30350,6 +31501,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -30698,11 +31850,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -30712,11 +31864,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -30726,6 +31879,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -30825,7 +31979,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -30863,6 +32027,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -30887,6 +32052,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -31056,6 +32226,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -31098,7 +32269,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -31136,6 +32317,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -31160,6 +32342,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -31389,6 +32576,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -31639,11 +32827,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -31653,11 +32841,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -31667,6 +32856,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -31766,7 +32956,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -31804,6 +33004,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -31828,6 +33029,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -31997,6 +33203,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -32039,7 +33246,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -32077,6 +33294,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -32101,6 +33319,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -32330,6 +33553,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -32465,11 +33689,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -32479,11 +33703,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -32493,6 +33718,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -32592,7 +33818,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -32630,6 +33866,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -32654,6 +33891,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -32823,6 +34065,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -32865,7 +34108,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -32903,6 +34156,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -32927,6 +34181,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -33156,6 +34415,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, @@ -33504,11 +34764,11 @@

Method Details

"widgets": [ # All the widgets in the section. Must contain at least one widget. { # Each card is made up of widgets. A widget is a composite object that can represent one of text, images, buttons, and other object types. "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A list of buttons. For example, the following JSON creates two buttons. The first is a blue text button and the second is an image button that opens a link: ``` "buttonList": { "buttons": [ { "text": "Edit", "color": { "red": 0, "green": 0, "blue": 1, }, "disabled": true, }, { "icon": { "knownIcon": "INVITE", "altText": "check calendar" }, "onClick": { "openLink": { "url": "https://example.com/calendar" } } } ] } ``` - "carousel": { # [Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` + "carousel": { # A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { "carouselCards": [ { "widgets": [ { "textParagraph": { "text": "First text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Second text paragraph in carousel", } } ] }, { "widgets": [ { "textParagraph": { "text": "Third text paragraph in carousel", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat): # A carousel contains a collection of nested widgets. For example, this is a JSON representation of a carousel that contains two text paragraphs. ``` { "widgets": [ { "textParagraph": { "text": "First text paragraph in the carousel." } }, { "textParagraph": { "text": "Second text paragraph in the carousel." } } ] } ``` "carouselCards": [ # A list of cards included in the carousel. - { # [Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat): "footerWidgets": [ # A list of widgets displayed at the bottom of the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -33518,11 +34778,12 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], "widgets": [ # A list of widgets displayed in the carousel card. The widgets are displayed in the order that they are specified. - { # [Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): + { # A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat): "buttonList": # Object with schema name: GoogleAppsCardV1ButtonList # A button list widget. "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An image widget. "altText": "A String", # The alternative text of this image that's used for accessibility. @@ -33532,6 +34793,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # A text paragraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -33631,7 +34893,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # DecoratedText widget. "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -33669,6 +34941,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -33693,6 +34966,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "image": { # An image that is specified by a URL and can have an `onClick` action. For an example, see [Add an image](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_image). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Image widget. @@ -33862,6 +35140,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # TextParagraph widget. "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, }, ], @@ -33904,7 +35183,17 @@

Method Details

}, "decoratedText": { # A widget that displays text with optional decorations such as a label above or below the text, an icon in front of the text, a selection widget, or a button after the text. For an example in Google Chat apps, see [Display text with decorative text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#display_text_with_decorative_elements). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a decorated text item. For example, the following JSON creates a decorated text widget showing email address: ``` "decoratedText": { "icon": { "knownIcon": "EMAIL" }, "topLabel": "Email Address", "text": "sasha@example.com", "bottomLabel": "This is a new Email address!", "switchControl": { "name": "has_send_welcome_email_to_sasha", "selected": false, "controlType": "CHECKBOX" } } ``` "bottomLabel": "A String", # The text that appears below `text`. Always wraps. + "bottomLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "button": # Object with schema name: GoogleAppsCardV1Button # A button that a user can click to trigger an action. + "contentText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "endIcon": { # An icon displayed in a widget on a card. For an example in Google Chat apps, see [Add an icon](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_an_icon). Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons. "altText": "A String", # Optional. A description of the icon used for accessibility. If unspecified, the default value `Button` is provided. As a best practice, you should set a helpful description for what the icon displays, and if applicable, what it does. For example, `A user's account portrait`, or `Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat`. If the icon is set in a `Button`, the `altText` appears as helper text when the user hovers over the button. However, if the button also sets `text`, the icon's `altText` is ignored. "iconUrl": "A String", # Display a custom icon hosted at an HTTPS URL. For example: ``` "iconUrl": "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png" ``` Supported file types include `.png` and `.jpg`. @@ -33942,6 +35231,7 @@

Method Details

"weight": 42, # The stroke weight of the icon. Choose from {100, 200, 300, 400, 500, 600, 700}. If absent, default value is 400. If any other value is specified, the default value is used. To preview different icon settings, go to [Google Font Icons](https://fonts.google.com/icons) and adjust the settings under **Customize**. }, }, + "startIconVerticalAlignment": "A String", # Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat): "switchControl": { # Either a toggle-style switch or a checkbox inside a `decoratedText` widget. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): Only supported in the `decoratedText` widget. # A switch widget that a user can click to change its state and trigger an action. "controlType": "A String", # How the switch appears in the user interface. [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): "name": "A String", # The name by which the switch widget is identified in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). @@ -33966,6 +35256,11 @@

Method Details

}, "text": "A String", # Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). "topLabel": "A String", # The text that appears above `text`. Always truncates. + "topLabelText": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # `TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat): + "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. + "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): + }, "wrapText": True or False, # The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`. }, "divider": { # Displays a divider between widgets as a horizontal line. For an example in Google Chat apps, see [Add a horizontal divider between widgets](https://developers.google.com/workspace/chat/format-structure-card-dialog#add_a_horizontal_divider_between_widgets). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): For example, the following JSON creates a divider: ``` "divider": {} ``` # Displays a horizontal line divider between widgets. For example, the following JSON creates a divider: ``` "divider": { } ``` @@ -34195,6 +35490,7 @@

Method Details

"textParagraph": { # A paragraph of text that supports formatting. For an example in Google Chat apps, see [Add a paragraph of formatted text](https://developers.google.com/workspace/chat/add-text-image-card-dialog#add_a_paragraph_of_formatted_text). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). [Google Workspace add-ons and Chat apps](https://developers.google.com/workspace/extend): # Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/workspace/chat/format-messages#card-formatting) and [Formatting text in Google Workspace add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" } ``` "maxLines": 42, # The maximum number of lines of text that are displayed in the widget. If the text exceeds the specified maximum number of lines, the excess content is concealed behind a **show more** button. If the text is equal or shorter than the specified maximum number of lines, a **show more** button isn't displayed. The default value is 0, in which case all context is displayed. Negative values are ignored. "text": "A String", # The text that's shown in the widget. + "textSyntax": "A String", # The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat): }, "visibility": "A String", # Specifies whether the widget is visible or hidden. The default value is `VISIBLE`. Only supported by Google Workspace Workflow, but not Google Chat apps or Google Workspace add-ons. }, diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 44c0b6bdb52..e544dde8aa8 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -1528,7 +1528,7 @@ } } }, -"revision": "20250909", +"revision": "20250916", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2754,7 +2754,7 @@ "type": "object" }, "GoogleAppsCardV1Carousel": { -"description": "[Developer Preview](https://developers.google.com/workspace/preview): A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { \"carouselCards\": [ { \"widgets\": [ { \"textParagraph\": { \"text\": \"First text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Second text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Third text paragraph in carousel\", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat):", +"description": "A carousel, also known as a slider, rotates and displays a list of widgets in a slideshow format, with buttons navigating to the previous or next widget. For example, this is a JSON representation of a carousel that contains three text paragraph widgets. ``` { \"carouselCards\": [ { \"widgets\": [ { \"textParagraph\": { \"text\": \"First text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Second text paragraph in carousel\", } } ] }, { \"widgets\": [ { \"textParagraph\": { \"text\": \"Third text paragraph in carousel\", } } ] } ] } ``` [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "GoogleAppsCardV1Carousel", "properties": { "carouselCards": { @@ -2768,7 +2768,7 @@ "type": "object" }, "GoogleAppsCardV1CarouselCard": { -"description": "[Developer Preview](https://developers.google.com/workspace/preview): A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):", +"description": "A card that can be displayed as a carousel item. [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "GoogleAppsCardV1CarouselCard", "properties": { "footerWidgets": { @@ -3049,10 +3049,18 @@ "description": "The text that appears below `text`. Always wraps.", "type": "string" }, +"bottomLabelText": { +"$ref": "GoogleAppsCardV1TextParagraph", +"description": "`TextParagraph` equivalent of `bottom_label`. Always wraps. Allows for more complex formatting than `bottom_label`. [Google Chat apps](https://developers.google.com/workspace/chat):" +}, "button": { "$ref": "GoogleAppsCardV1Button", "description": "A button that a user can click to trigger an action." }, +"contentText": { +"$ref": "GoogleAppsCardV1TextParagraph", +"description": "`TextParagraph` equivalent of `text`. Allows for more complex formatting than `text`. [Google Chat apps](https://developers.google.com/workspace/chat):" +}, "endIcon": { "$ref": "GoogleAppsCardV1Icon", "description": "An icon displayed after the text. Supports [built-in](https://developers.google.com/workspace/chat/format-messages#builtinicons) and [custom](https://developers.google.com/workspace/chat/format-messages#customicons) icons." @@ -3070,6 +3078,22 @@ "$ref": "GoogleAppsCardV1Icon", "description": "The icon displayed in front of the text." }, +"startIconVerticalAlignment": { +"description": "Optional. Vertical alignment of the start icon. If not set, the icon will be vertically centered. [Google Chat apps](https://developers.google.com/workspace/chat):", +"enum": [ +"VERTICAL_ALIGNMENT_UNSPECIFIED", +"TOP", +"MIDDLE", +"BOTTOM" +], +"enumDescriptions": [ +"Unspecified type. Do not use.", +"Alignment to the top position.", +"Alignment to the middle position.", +"Alignment to the bottom position." +], +"type": "string" +}, "switchControl": { "$ref": "GoogleAppsCardV1SwitchControl", "description": "A switch widget that a user can click to change its state and trigger an action." @@ -3082,6 +3106,10 @@ "description": "The text that appears above `text`. Always truncates.", "type": "string" }, +"topLabelText": { +"$ref": "GoogleAppsCardV1TextParagraph", +"description": "`TextParagraph` equivalent of `top_label`. Always truncates. Allows for more complex formatting than `top_label`. [Google Chat apps](https://developers.google.com/workspace/chat):" +}, "wrapText": { "description": "The wrap text setting. If `true`, the text wraps and displays on multiple lines. Otherwise, the text is truncated. Only applies to `text`, not `topLabel` and `bottomLabel`.", "type": "boolean" @@ -3368,7 +3396,7 @@ "type": "object" }, "GoogleAppsCardV1NestedWidget": { -"description": "[Developer Preview](https://developers.google.com/workspace/preview): A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):", +"description": "A list of widgets that can be displayed in a containing layout, such as a `CarouselCard`. [Google Chat apps](https://developers.google.com/workspace/chat):", "id": "GoogleAppsCardV1NestedWidget", "properties": { "buttonList": { @@ -3775,6 +3803,20 @@ "text": { "description": "The text that's shown in the widget.", "type": "string" +}, +"textSyntax": { +"description": "The syntax of the text. If not set, the text is rendered as HTML. [Google Chat apps](https://developers.google.com/workspace/chat):", +"enum": [ +"TEXT_SYNTAX_UNSPECIFIED", +"HTML", +"MARKDOWN" +], +"enumDescriptions": [ +"The text is rendered as HTML if unspecified.", +"The text is rendered as HTML. This is the default value.", +"The text is rendered as Markdown." +], +"type": "string" } }, "type": "object" From 6acd1a9da6162f553550f0a2285e7ae63c2945fd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 23 Sep 2025 07:09:07 +0000 Subject: [PATCH 06/26] feat(cloudcommerceprocurement): update the api #### cloudcommerceprocurement:v1 The following keys were added: - resources.providers.resources.accounts.methods.get.parameters.view (Total Keys: 2) - schemas.Account.properties.resellerParentBillingAccount.type (Total Keys: 1) --- ...erceprocurement_v1.providers.accounts.html | 11 ++++++++-- .../cloudcommerceprocurement.v1.json | 21 ++++++++++++++++++- 2 files changed, 29 insertions(+), 3 deletions(-) diff --git a/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html b/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html index 7451a8c79a0..4cc645b6bbd 100644 --- a/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html +++ b/docs/dyn/cloudcommerceprocurement_v1.providers.accounts.html @@ -81,7 +81,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, x__xgafv=None)

+ get(name, view=None, x__xgafv=None)

Gets a requested Account resource.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

@@ -131,11 +131,16 @@

Method Details

- get(name, x__xgafv=None) + get(name, view=None, x__xgafv=None) 
Gets a requested Account resource.
 
 Args:
   name: string, Required. The name of the account to retrieve. (required)
+  view: string, Optional. What information to include in the response.
+    Allowed values
+      ACCOUNT_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view for ListAccounts. For GetAccount it will default to the FULL view.
+      ACCOUNT_VIEW_BASIC - Include base account information. This is the default view.
+      ACCOUNT_VIEW_FULL - Include everything.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -159,6 +164,7 @@ 
Method Details

   },
   "name": "A String", # Output only. The resource name of the account. Account names have the form `accounts/{account_id}`.
   "provider": "A String", # Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.
+  "resellerParentBillingAccount": "A String", # The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id}
   "state": "A String", # Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.
   "updateTime": "A String", # Output only. The last update timestamp.
 }
@@ -197,6 +203,7 @@

Method Details

}, "name": "A String", # Output only. The resource name of the account. Account names have the form `accounts/{account_id}`. "provider": "A String", # Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform. + "resellerParentBillingAccount": "A String", # The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id} "state": "A String", # Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example. "updateTime": "A String", # Output only. The last update timestamp. }, diff --git a/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json b/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json index 82aa1f365dd..693a7dc5dd2 100644 --- a/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudcommerceprocurement.v1.json @@ -152,6 +152,21 @@ "pattern": "^providers/[^/]+/accounts/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. What information to include in the response.", +"enum": [ +"ACCOUNT_VIEW_UNSPECIFIED", +"ACCOUNT_VIEW_BASIC", +"ACCOUNT_VIEW_FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the BASIC view for ListAccounts. For GetAccount it will default to the FULL view.", +"Include base account information. This is the default view.", +"Include everything." +], +"location": "query", +"type": "string" } }, "path": "v1/{+name}", @@ -503,7 +518,7 @@ } } }, -"revision": "20250907", +"revision": "20250914", "rootUrl": "https://cloudcommerceprocurement.googleapis.com/", "schemas": { "Account": { @@ -539,6 +554,10 @@ "description": "Output only. The identifier of the service provider that this account was created against. Each service provider is assigned a unique provider value when they onboard with Cloud Commerce platform.", "type": "string" }, +"resellerParentBillingAccount": { +"description": "The reseller parent billing account of the account's corresponding billing account, applicable only when the corresponding billing account is a subaccount of a reseller. Included in responses only for view ACCOUNT_VIEW_FULL. Format: billingAccounts/{billing_account_id}", +"type": "string" +}, "state": { "description": "Output only. The state of the account. This is used to decide whether the customer is in good standing with the provider and is able to make purchases. An account might not be able to make a purchase if the billing account is suspended, for example.", "enum": [ From 957b7dcd5fe6d67929fa68003a2e2fe52ca59f74 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 23 Sep 2025 07:09:07 +0000 Subject: [PATCH 07/26] feat(cloudidentity): update the api #### cloudidentity:v1beta1 The following keys were added: - resources.devices.resources.deviceUsers.methods.lookup.parameters.iosDeviceId (Total Keys: 2) - resources.devices.resources.deviceUsers.methods.lookup.parameters.partner (Total Keys: 2) --- .../cloudidentity_v1beta1.devices.deviceUsers.html | 10 ++++++---- .../documents/cloudidentity.v1beta1.json | 14 ++++++++++++-- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html b/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html index a482bfd9e26..2f83e77ceb9 100644 --- a/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html +++ b/docs/dyn/cloudidentity_v1beta1.devices.deviceUsers.html @@ -104,8 +104,8 @@

Instance Methods

list_next()

Retrieves the next page of results.

- lookup(parent, androidId=None, pageSize=None, pageToken=None, rawResourceId=None, userId=None, x__xgafv=None)

-

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

+ lookup(parent, androidId=None, iosDeviceId=None, pageSize=None, pageToken=None, partner=None, rawResourceId=None, userId=None, x__xgafv=None)

+

Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.

lookup_next()

Retrieves the next page of results.

@@ -362,14 +362,16 @@

Method Details

- lookup(parent, androidId=None, pageSize=None, pageToken=None, rawResourceId=None, userId=None, x__xgafv=None) - 
Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.
+    lookup(parent, androidId=None, iosDeviceId=None, pageSize=None, pageToken=None, partner=None, rawResourceId=None, userId=None, x__xgafv=None)
+  
Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.
 
 Args:
   parent: string, Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. (required)
   androidId: string, Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID).
+  iosDeviceId: string, Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps.
   pageSize: integer, The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.
   pageToken: string, A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `LookupDeviceUsers` must match the call that provided the page token.
+  partner: string, Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps.
   rawResourceId: string, Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json
   userId: string, The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user.
   x__xgafv: string, V1 error format.
diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json
index 6160beaf363..a38965c4fc7 100644
--- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json
@@ -680,7 +680,7 @@
 ]
 },
 "lookup": {
-"description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.",
+"description": "Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: Specifying the 'partner' and 'ios_device_id' fields is required. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.",
 "flatPath": "v1beta1/devices/{devicesId}/deviceUsers:lookup",
 "httpMethod": "GET",
 "id": "cloudidentity.devices.deviceUsers.lookup",
@@ -693,6 +693,11 @@
 "location": "query",
 "type": "string"
 },
+"iosDeviceId": {
+"description": "Optional. The partner-specified device identifier assigned to the iOS device that initiated the Lookup API call. This string must match the value of the iosDeviceId key in the app config dictionary provided to Google Workspace apps.",
+"location": "query",
+"type": "string"
+},
 "pageSize": {
 "description": "The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.",
 "format": "int32",
@@ -711,6 +716,11 @@
 "required": true,
 "type": "string"
 },
+"partner": {
+"description": "Optional. The partner ID of the calling iOS app. This string must match the value of the partner key within the app configuration dictionary provided to Google Workspace apps.",
+"location": "query",
+"type": "string"
+},
 "rawResourceId": {
 "description": "Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\\Users\\%USERPROFILE%\\.secureConnect\\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json",
 "location": "query",
@@ -2268,7 +2278,7 @@
 }
 }
 },
-"revision": "20250805",
+"revision": "20250916",
 "rootUrl": "https://cloudidentity.googleapis.com/",
 "schemas": {
 "AddIdpCredentialOperationMetadata": {

From 975916ba57714af3800d9b943210d0a608ae922d Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:07 +0000
Subject: [PATCH 08/26] feat(cloudkms): update the api

#### cloudkms:v1

The following keys were added:
- resources.projects.methods.getAutokeyConfig (Total Keys: 11)
- resources.projects.methods.updateAutokeyConfig (Total Keys: 15)
---
 docs/dyn/cloudkms_v1.folders.html             |  6 +-
 docs/dyn/cloudkms_v1.projects.html            | 61 ++++++++++++++++
 docs/dyn/cloudkms_v1.projects.locations.html  |  2 +-
 .../documents/cloudkms.v1.json                | 69 +++++++++++++++++--
 4 files changed, 130 insertions(+), 8 deletions(-)

diff --git a/docs/dyn/cloudkms_v1.folders.html b/docs/dyn/cloudkms_v1.folders.html
index 1c1ae25c76e..8ebcc7e9a4f 100644
--- a/docs/dyn/cloudkms_v1.folders.html
+++ b/docs/dyn/cloudkms_v1.folders.html
@@ -79,7 +79,7 @@ 
Instance Methods

 
Close httplib2 connections.

 

   getAutokeyConfig(name, x__xgafv=None)

-
Returns the AutokeyConfig for a folder.

+
Returns the AutokeyConfig for a folder or project.

 

   getKajPolicyConfig(name, x__xgafv=None)

 
Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.

@@ -97,10 +97,10 @@ 
Method Details

 
 

     getAutokeyConfig(name, x__xgafv=None)
-  
Returns the AutokeyConfig for a folder.
+  
Returns the AutokeyConfig for a folder or project.
 
 Args:
-  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`. (required)
+  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/cloudkms_v1.projects.html b/docs/dyn/cloudkms_v1.projects.html
index 22142553a75..a5fe282dadd 100644
--- a/docs/dyn/cloudkms_v1.projects.html
+++ b/docs/dyn/cloudkms_v1.projects.html
@@ -82,6 +82,9 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  getAutokeyConfig(name, x__xgafv=None)

+
Returns the AutokeyConfig for a folder or project.

 

   getKajPolicyConfig(name, x__xgafv=None)

 
Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.

@@ -94,6 +97,9 @@ 
Instance Methods

 

   showEffectiveKeyAccessJustificationsPolicyConfig(project, x__xgafv=None)

 
Returns the KeyAccessJustificationsPolicyConfig of the resource closest to the given project in hierarchy.

+

+  updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)

+
Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.

 

   updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)

 
Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.

@@ -103,6 +109,28 @@ 
Method Details

   
Close httplib2 connections.

 

 
+

+    getAutokeyConfig(name, x__xgafv=None)
+  
Returns the AutokeyConfig for a folder or project.
+
+Args:
+  name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Cloud KMS Autokey configuration for a folder or project.
+  "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
+  "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
+  "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.
+  "state": "A String", # Output only. The state for the AutokeyConfig.
+}

+

+
 

     getKajPolicyConfig(name, x__xgafv=None)
   
Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
@@ -202,6 +230,39 @@ 
Method Details

 }

 

 
+

+    updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)
+  
Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
+
+Args:
+  name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Cloud KMS Autokey configuration for a folder or project.
+  "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
+  "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
+  "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.
+  "state": "A String", # Output only. The state for the AutokeyConfig.
+}
+
+  updateMask: string, Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Cloud KMS Autokey configuration for a folder or project.
+  "etag": "A String", # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
+  "keyProject": "A String", # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
+  "name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.
+  "state": "A String", # Output only. The state for the AutokeyConfig.
+}

+

+
 

     updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)
   
Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.
diff --git a/docs/dyn/cloudkms_v1.projects.locations.html b/docs/dyn/cloudkms_v1.projects.locations.html
index 700f3d7c185..e3a2da1098e 100644
--- a/docs/dyn/cloudkms_v1.projects.locations.html
+++ b/docs/dyn/cloudkms_v1.projects.locations.html
@@ -207,7 +207,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
index 1673070f4ed..13ec9ce0d47 100644
--- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json
+++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json
@@ -203,7 +203,7 @@
 "folders": {
 "methods": {
 "getAutokeyConfig": {
-"description": "Returns the AutokeyConfig for a folder.",
+"description": "Returns the AutokeyConfig for a folder or project.",
 "flatPath": "v1/folders/{foldersId}/autokeyConfig",
 "httpMethod": "GET",
 "id": "cloudkms.folders.getAutokeyConfig",
@@ -212,7 +212,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.",
+"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.",
 "location": "path",
 "pattern": "^folders/[^/]+/autokeyConfig$",
 "required": true,
@@ -393,6 +393,32 @@
 },
 "projects": {
 "methods": {
+"getAutokeyConfig": {
+"description": "Returns the AutokeyConfig for a folder or project.",
+"flatPath": "v1/projects/{projectsId}/autokeyConfig",
+"httpMethod": "GET",
+"id": "cloudkms.projects.getAutokeyConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`.",
+"location": "path",
+"pattern": "^projects/[^/]+/autokeyConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "AutokeyConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloudkms"
+]
+},
 "getKajPolicyConfig": {
 "description": "Gets the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.",
 "flatPath": "v1/projects/{projectsId}/kajPolicyConfig",
@@ -497,6 +523,41 @@
 "https://www.googleapis.com/auth/cloudkms"
 ]
 },
+"updateAutokeyConfig": {
+"description": "Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.",
+"flatPath": "v1/projects/{projectsId}/autokeyConfig",
+"httpMethod": "PATCH",
+"id": "cloudkms.projects.updateAutokeyConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.",
+"location": "path",
+"pattern": "^projects/[^/]+/autokeyConfig$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "AutokeyConfig"
+},
+"response": {
+"$ref": "AutokeyConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/cloudkms"
+]
+},
 "updateKajPolicyConfig": {
 "description": "Updates the KeyAccessJustificationsPolicyConfig for a given organization/folder/projects.",
 "flatPath": "v1/projects/{projectsId}/kajPolicyConfig",
@@ -627,7 +688,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -2435,7 +2496,7 @@
 }
 }
 },
-"revision": "20250818",
+"revision": "20250911",
 "rootUrl": "https://cloudkms.googleapis.com/",
 "schemas": {
 "AsymmetricDecryptRequest": {

From 583463137fa260a774b425c2b17630dae4fd9953 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:07 +0000
Subject: [PATCH 09/26] feat(compute): update the api

#### compute:alpha

The following keys were added:
- resources.networks.methods.cancelRequestRemovePeering (Total Keys: 18)
- resources.organizationSecurityPolicies.methods.patch.parameters.updateMask (Total Keys: 3)
- resources.organizationSecurityPolicies.methods.patchRule.parameters.updateMask (Total Keys: 3)
- resources.projects.methods.moveDisk.deprecated (Total Keys: 1)
- schemas.NetworksCancelRequestRemovePeeringRequest (Total Keys: 3)
- schemas.RouterBgpPeer.properties.linkedCustomHardware.type (Total Keys: 1)
- schemas.RouterStatusBgpPeerStatus.properties.linkedCustomHardware.type (Total Keys: 1)

#### compute:beta

The following keys were added:
- resources.organizationSecurityPolicies.methods.patch.parameters.updateMask (Total Keys: 3)
- resources.organizationSecurityPolicies.methods.patchRule.parameters.updateMask (Total Keys: 3)
- resources.projects.methods.moveDisk.deprecated (Total Keys: 1)
- schemas.InterconnectLocation.properties.singleRegionProductionCriticalPeerLocations (Total Keys: 2)

#### compute:v1

The following keys were added:
- resources.projects.methods.moveDisk.deprecated (Total Keys: 1)
- resources.subnetworks.methods.get.parameters.views (Total Keys: 3)
- resources.subnetworks.methods.list.parameters.views (Total Keys: 3)
- schemas.InterconnectLocation.properties.singleRegionProductionCriticalPeerLocations (Total Keys: 2)
- schemas.InterconnectRemoteLocation.properties.maxLagSize400Gbps (Total Keys: 2)
- schemas.RequestMirrorPolicy.properties.mirrorPercent (Total Keys: 2)
- schemas.Subnetwork.properties.utilizationDetails (Total Keys: 2)
- schemas.SubnetworkUtilizationDetails (Total Keys: 18)
---
 docs/dyn/compute_alpha.networks.html          | 135 +++++++++++
 ...te_alpha.organizationSecurityPolicies.html |  10 +-
 docs/dyn/compute_alpha.projects.html          |   4 +-
 docs/dyn/compute_alpha.routers.html           |   9 +
 .../compute_beta.interconnectLocations.html   |   6 +
 ...ute_beta.organizationSecurityPolicies.html |  10 +-
 docs/dyn/compute_beta.projects.html           |   4 +-
 .../dyn/compute_v1.interconnectLocations.html |   6 +
 ...ompute_v1.interconnectRemoteLocations.html |   2 +
 docs/dyn/compute_v1.projects.html             |   4 +-
 docs/dyn/compute_v1.regionUrlMaps.html        |  24 ++
 docs/dyn/compute_v1.subnetworks.html          | 211 +++++++++++++++++-
 docs/dyn/compute_v1.urlMaps.html              |  28 +++
 .../documents/compute.alpha.json              |  81 ++++++-
 .../documents/compute.beta.json               |  24 +-
 .../discovery_cache/documents/compute.v1.json | 113 +++++++++-
 16 files changed, 647 insertions(+), 24 deletions(-)

diff --git a/docs/dyn/compute_alpha.networks.html b/docs/dyn/compute_alpha.networks.html
index 184bd3616de..d24f85ba123 100644
--- a/docs/dyn/compute_alpha.networks.html
+++ b/docs/dyn/compute_alpha.networks.html
@@ -77,6 +77,9 @@ 
Instance Methods

 

   addPeering(project, network, body=None, requestId=None, x__xgafv=None)

 
Adds a peering to the specified network.

+

+  cancelRequestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)

+
Cancel requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. Cancels a request to remove a peering from the specified network.

 

   close()

 
Close httplib2 connections.

@@ -301,6 +304,138 @@ 
Method Details

 }

 

 
+

+    cancelRequestRemovePeering(project, network, body=None, requestId=None, x__xgafv=None)
+  
Cancel requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. Cancels a request to remove a peering from the specified network.
+
+Args:
+  project: string, Project ID for this request. (required)
+  network: string, Name of the network resource to remove peering from. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "name": "A String", # Name of the peering, which should conform to RFC1035.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match a regular expression of `a-z+` but should ideally be lowerCamelCase. Also, they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than `{"instanceLimit": "100/request"}`, should be returned as, `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}

+

+
 

     close()
   
Close httplib2 connections.

diff --git a/docs/dyn/compute_alpha.organizationSecurityPolicies.html b/docs/dyn/compute_alpha.organizationSecurityPolicies.html
index cf743ab9f9f..721c6239e01 100644
--- a/docs/dyn/compute_alpha.organizationSecurityPolicies.html
+++ b/docs/dyn/compute_alpha.organizationSecurityPolicies.html
@@ -117,10 +117,10 @@ 
Instance Methods

   move(securityPolicy, parentId=None, requestId=None, x__xgafv=None)

 
Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.

 

-  patch(securityPolicy, body=None, requestId=None, x__xgafv=None)

+  patch(securityPolicy, body=None, requestId=None, updateMask=None, x__xgafv=None)

 
Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.

 

-  patchRule(securityPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

+  patchRule(securityPolicy, body=None, priority=None, requestId=None, updateMask=None, x__xgafv=None)

 
Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.

 

   removeAssociation(securityPolicy, name=None, requestId=None, x__xgafv=None)

@@ -2244,7 +2244,7 @@ 
Method Details

 

 
 

-    patch(securityPolicy, body=None, requestId=None, x__xgafv=None)
+    patch(securityPolicy, body=None, requestId=None, updateMask=None, x__xgafv=None)
   
Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.
 
 Args:
@@ -2523,6 +2523,7 @@ 
Method Details

 }
 
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  updateMask: string, Indicates fields to be cleared as part of this request.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -2641,7 +2642,7 @@ 
Method Details

 

 
 

-    patchRule(securityPolicy, body=None, priority=None, requestId=None, x__xgafv=None)
+    patchRule(securityPolicy, body=None, priority=None, requestId=None, updateMask=None, x__xgafv=None)
   
Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.
 
 Args:
@@ -2820,6 +2821,7 @@ 
Method Details

 
   priority: integer, The priority of the rule to patch.
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  updateMask: string, Indicates fields to be cleared as part of this request.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/compute_alpha.projects.html b/docs/dyn/compute_alpha.projects.html
index 35355b34275..dd55a45b39f 100644
--- a/docs/dyn/compute_alpha.projects.html
+++ b/docs/dyn/compute_alpha.projects.html
@@ -109,7 +109,7 @@ 
Instance Methods

 
Retrieves the next page of results.

 

   moveDisk(project, body=None, requestId=None, x__xgafv=None)

-
Moves a persistent disk from one zone to another.

+
Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.

 

   moveInstance(project, body=None, requestId=None, x__xgafv=None)

 
Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.

@@ -910,7 +910,7 @@ 
Method Details

 
 

     moveDisk(project, body=None, requestId=None, x__xgafv=None)
-  
Moves a persistent disk from one zone to another.
+  
Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html
index 504e4c1cda9..80671f101cd 100644
--- a/docs/dyn/compute_alpha.routers.html
+++ b/docs/dyn/compute_alpha.routers.html
@@ -248,6 +248,7 @@ 
Method Details

               "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
               "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
               "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+              "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface.
               "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
               "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.
               "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
@@ -867,6 +868,7 @@ 
Method Details

       "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
       "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
       "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+      "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface.
       "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
       "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.
       "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
@@ -1463,6 +1465,7 @@ 
Method Details

         "ipAddress": "A String", # IP address of the local BGP interface.
         "ipv4NexthopAddress": "A String", # IPv4 address of the local BGP interface.
         "ipv6NexthopAddress": "A String", # IPv6 address of the local BGP interface.
+        "linkedCustomHardware": "A String", # The URI of the linked custom hardware resource, CustomHardwareLinkAttachment. This CustomHardwareLinkAttachment resource is the one that will establish the BGP session from the Cloud Router.
         "linkedVpnTunnel": "A String", # URL of the VPN tunnel that this BGP peer controls.
         "md5AuthEnabled": True or False, # Informs whether MD5 authentication is enabled on this BGP peer.
         "name": "A String", # Name of this BGP peer. Unique within the Routers resource.
@@ -1586,6 +1589,7 @@ 
Method Details

       "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
       "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
       "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+      "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface.
       "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
       "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.
       "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
@@ -1900,6 +1904,7 @@ 
Method Details

           "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
           "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
           "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+          "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface.
           "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
           "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.
           "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
@@ -2364,6 +2369,7 @@ 
Method Details

       "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
       "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
       "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+      "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface.
       "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
       "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.
       "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
@@ -2964,6 +2970,7 @@ 
Method Details

       "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
       "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
       "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+      "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface.
       "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
       "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.
       "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
@@ -3146,6 +3153,7 @@ 
Method Details

         "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
         "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
         "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+        "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface.
         "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
         "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.
         "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
@@ -3364,6 +3372,7 @@ 
Method Details

       "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
       "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
       "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+      "linkedCustomHardware": "A String", # The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface.
       "managementType": "A String", # [Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.
       "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the name of one of the entries in the Router.md5_authentication_keys. The field must comply with RFC1035.
       "name": "A String", # Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
diff --git a/docs/dyn/compute_beta.interconnectLocations.html b/docs/dyn/compute_beta.interconnectLocations.html
index 31b9d463a01..24fe7b806a1 100644
--- a/docs/dyn/compute_beta.interconnectLocations.html
+++ b/docs/dyn/compute_beta.interconnectLocations.html
@@ -139,6 +139,9 @@ 
Method Details

     },
   ],
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "singleRegionProductionCriticalPeerLocations": [ # [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.
+    "A String",
+  ],
   "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
   "supportsPzs": True or False, # [Output Only] Reserved for future use.
 }

@@ -198,6 +201,9 @@ 
Method Details

         },
       ],
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "singleRegionProductionCriticalPeerLocations": [ # [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.
+        "A String",
+      ],
       "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
       "supportsPzs": True or False, # [Output Only] Reserved for future use.
     },
diff --git a/docs/dyn/compute_beta.organizationSecurityPolicies.html b/docs/dyn/compute_beta.organizationSecurityPolicies.html
index 0645da84eac..d465b0342e5 100644
--- a/docs/dyn/compute_beta.organizationSecurityPolicies.html
+++ b/docs/dyn/compute_beta.organizationSecurityPolicies.html
@@ -117,10 +117,10 @@ 
Instance Methods

   move(securityPolicy, parentId=None, requestId=None, x__xgafv=None)

 
Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move instead.

 

-  patch(securityPolicy, body=None, requestId=None, x__xgafv=None)

+  patch(securityPolicy, body=None, requestId=None, updateMask=None, x__xgafv=None)

 
Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.

 

-  patchRule(securityPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

+  patchRule(securityPolicy, body=None, priority=None, requestId=None, updateMask=None, x__xgafv=None)

 
Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.

 

   removeAssociation(securityPolicy, name=None, requestId=None, x__xgafv=None)

@@ -2149,7 +2149,7 @@ 
Method Details

 

 
 

-    patch(securityPolicy, body=None, requestId=None, x__xgafv=None)
+    patch(securityPolicy, body=None, requestId=None, updateMask=None, x__xgafv=None)
   
Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch instead.
 
 Args:
@@ -2409,6 +2409,7 @@ 
Method Details

 }
 
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  updateMask: string, Indicates fields to be cleared as part of this request.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -2526,7 +2527,7 @@ 
Method Details

 

 
 

-    patchRule(securityPolicy, body=None, priority=None, requestId=None, x__xgafv=None)
+    patchRule(securityPolicy, body=None, priority=None, requestId=None, updateMask=None, x__xgafv=None)
   
Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule instead.
 
 Args:
@@ -2691,6 +2692,7 @@ 
Method Details

 
   priority: integer, The priority of the rule to patch.
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  updateMask: string, Indicates fields to be cleared as part of this request.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/compute_beta.projects.html b/docs/dyn/compute_beta.projects.html
index bdb5dc51643..8035e452f2f 100644
--- a/docs/dyn/compute_beta.projects.html
+++ b/docs/dyn/compute_beta.projects.html
@@ -109,7 +109,7 @@ 
Instance Methods

 
Retrieves the next page of results.

 

   moveDisk(project, body=None, requestId=None, x__xgafv=None)

-
Moves a persistent disk from one zone to another.

+
Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.

 

   moveInstance(project, body=None, requestId=None, x__xgafv=None)

 
Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.

@@ -902,7 +902,7 @@ 
Method Details

 
 

     moveDisk(project, body=None, requestId=None, x__xgafv=None)
-  
Moves a persistent disk from one zone to another.
+  
Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_v1.interconnectLocations.html b/docs/dyn/compute_v1.interconnectLocations.html
index f9e2fc2309e..c5744d26ed5 100644
--- a/docs/dyn/compute_v1.interconnectLocations.html
+++ b/docs/dyn/compute_v1.interconnectLocations.html
@@ -134,6 +134,9 @@ 
Method Details

     },
   ],
   "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "singleRegionProductionCriticalPeerLocations": [ # [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.
+    "A String",
+  ],
   "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
   "supportsPzs": True or False, # [Output Only] Reserved for future use.
 }

@@ -188,6 +191,9 @@ 
Method Details

         },
       ],
       "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "singleRegionProductionCriticalPeerLocations": [ # [Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.
+        "A String",
+      ],
       "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.
       "supportsPzs": True or False, # [Output Only] Reserved for future use.
     },
diff --git a/docs/dyn/compute_v1.interconnectRemoteLocations.html b/docs/dyn/compute_v1.interconnectRemoteLocations.html
index aef60b281d6..50cb7abd9bc 100644
--- a/docs/dyn/compute_v1.interconnectRemoteLocations.html
+++ b/docs/dyn/compute_v1.interconnectRemoteLocations.html
@@ -137,6 +137,7 @@ 
Method Details

   "lacp": "A String", # [Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED
   "maxLagSize100Gbps": 42, # [Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps.
   "maxLagSize10Gbps": 42, # [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps.
+  "maxLagSize400Gbps": 42, # [Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps.
   "name": "A String", # [Output Only] Name of the resource.
   "peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
   "permittedConnections": [ # [Output Only] Permitted connections.
@@ -202,6 +203,7 @@ 
Method Details

       "lacp": "A String", # [Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED
       "maxLagSize100Gbps": 42, # [Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps.
       "maxLagSize10Gbps": 42, # [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps.
+      "maxLagSize400Gbps": 42, # [Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps.
       "name": "A String", # [Output Only] Name of the resource.
       "peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).
       "permittedConnections": [ # [Output Only] Permitted connections.
diff --git a/docs/dyn/compute_v1.projects.html b/docs/dyn/compute_v1.projects.html
index 714bb4c6c8f..68e07b1d1b0 100644
--- a/docs/dyn/compute_v1.projects.html
+++ b/docs/dyn/compute_v1.projects.html
@@ -109,7 +109,7 @@ 
Instance Methods

 
Retrieves the next page of results.

 

   moveDisk(project, body=None, requestId=None, x__xgafv=None)

-
Moves a persistent disk from one zone to another.

+
Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.

 

   moveInstance(project, body=None, requestId=None, x__xgafv=None)

 
Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). [Deprecated] This method is deprecated. See [moving instance across zones](/compute/docs/instances/moving-instance-across-zones) instead.

@@ -896,7 +896,7 @@ 
Method Details

 
 

     moveDisk(project, body=None, requestId=None, x__xgafv=None)
-  
Moves a persistent disk from one zone to another.
+  
Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_v1.regionUrlMaps.html b/docs/dyn/compute_v1.regionUrlMaps.html
index 06b68a8bc80..c8f8713c2bc 100644
--- a/docs/dyn/compute_v1.regionUrlMaps.html
+++ b/docs/dyn/compute_v1.regionUrlMaps.html
@@ -302,6 +302,7 @@ 
Method Details

     },
     "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
       "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+      "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
     },
     "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
       "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -450,6 +451,7 @@ 
Method Details

         },
         "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
           "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+          "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
         },
         "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
           "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -589,6 +591,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -770,6 +773,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -917,6 +921,7 @@ 
Method Details

     },
     "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
       "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+      "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
     },
     "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
       "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1065,6 +1070,7 @@ 
Method Details

         },
         "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
           "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+          "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
         },
         "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
           "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1204,6 +1210,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1385,6 +1392,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1661,6 +1669,7 @@ 
Method Details

         },
         "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
           "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+          "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
         },
         "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
           "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1809,6 +1818,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1948,6 +1958,7 @@ 
Method Details

                 },
                 "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                   "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                  "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
                 },
                 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                   "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -2129,6 +2140,7 @@ 
Method Details

                 },
                 "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                   "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                  "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
                 },
                 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                   "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -2306,6 +2318,7 @@ 
Method Details

     },
     "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
       "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+      "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
     },
     "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
       "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -2454,6 +2467,7 @@ 
Method Details

         },
         "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
           "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+          "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
         },
         "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
           "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -2593,6 +2607,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -2774,6 +2789,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3038,6 +3054,7 @@ 
Method Details

     },
     "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
       "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+      "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
     },
     "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
       "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3186,6 +3203,7 @@ 
Method Details

         },
         "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
           "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+          "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
         },
         "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
           "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3325,6 +3343,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3506,6 +3525,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3771,6 +3791,7 @@ 
Method Details

       },
       "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
         "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+        "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
       },
       "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
         "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3919,6 +3940,7 @@ 
Method Details

           },
           "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
             "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+            "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
           },
           "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
             "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -4058,6 +4080,7 @@ 
Method Details

               },
               "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
               },
               "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -4239,6 +4262,7 @@ 
Method Details

               },
               "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
               },
               "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html
index 1be4e1a7460..d0f9d745da8 100644
--- a/docs/dyn/compute_v1.subnetworks.html
+++ b/docs/dyn/compute_v1.subnetworks.html
@@ -90,7 +90,7 @@ 
Instance Methods

   expandIpCidrRange(project, region, subnetwork, body=None, requestId=None, x__xgafv=None)

 
Expands the IP CIDR range of the subnetwork to a specified value.

 

-  get(project, region, subnetwork, x__xgafv=None)

+  get(project, region, subnetwork, views=None, x__xgafv=None)

 
Returns the specified subnetwork.

 

   getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

@@ -99,7 +99,7 @@ 
Instance Methods

   insert(project, region, body=None, requestId=None, x__xgafv=None)

 
Creates a subnetwork in the specified project using the data included in the request.

 

-  list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+  list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, views=None, x__xgafv=None)

 
Retrieves a list of subnetworks available to the specified project.

 

   listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProject=None, x__xgafv=None)

@@ -203,6 +203,45 @@ 
Method Details

           "systemReservedInternalIpv6Ranges": [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use.
             "A String",
           ],
+          "utilizationDetails": { # The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.
+            "externalIpv6InstanceUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range.
+              "totalAllocatedIp": {
+                "high": "A String",
+                "low": "A String",
+              },
+              "totalFreeIp": {
+                "high": "A String",
+                "low": "A String",
+              },
+            },
+            "externalIpv6LbUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB.
+              "totalAllocatedIp": {
+                "high": "A String",
+                "low": "A String",
+              },
+              "totalFreeIp": {
+                "high": "A String",
+                "low": "A String",
+              },
+            },
+            "internalIpv6Utilization": { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range.
+              "totalAllocatedIp": {
+                "high": "A String",
+                "low": "A String",
+              },
+              "totalFreeIp": {
+                "high": "A String",
+                "low": "A String",
+              },
+            },
+            "ipv4Utilizations": [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty.
+              { # The IPV4 utilization of a single IP range.
+                "rangeName": "A String", # Will be set for secondary range. Empty for primary IPv4 range.
+                "totalAllocatedIp": "A String",
+                "totalFreeIp": "A String",
+              },
+            ],
+          },
         },
       ],
       "warning": { # An informational warning that appears when the list of addresses is empty.
@@ -513,13 +552,17 @@ 
Method Details

 

 
 

-    get(project, region, subnetwork, x__xgafv=None)
+    get(project, region, subnetwork, views=None, x__xgafv=None)
   
Returns the specified subnetwork.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region scoping this request. (required)
   subnetwork: string, Name of the Subnetwork resource to return. (required)
+  views: string, Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.  (repeated)
+    Allowed values
+      DEFAULT - 
+      WITH_UTILIZATION - Utilization data is included in the response.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -582,6 +625,45 @@ 
Method Details

   "systemReservedInternalIpv6Ranges": [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use.
     "A String",
   ],
+  "utilizationDetails": { # The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.
+    "externalIpv6InstanceUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range.
+      "totalAllocatedIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+      "totalFreeIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+    },
+    "externalIpv6LbUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB.
+      "totalAllocatedIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+      "totalFreeIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+    },
+    "internalIpv6Utilization": { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range.
+      "totalAllocatedIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+      "totalFreeIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+    },
+    "ipv4Utilizations": [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty.
+      { # The IPV4 utilization of a single IP range.
+        "rangeName": "A String", # Will be set for secondary range. Empty for primary IPv4 range.
+        "totalAllocatedIp": "A String",
+        "totalFreeIp": "A String",
+      },
+    ],
+  },
 }

 

 
@@ -699,6 +781,45 @@ 
Method Details

   "systemReservedInternalIpv6Ranges": [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use.
     "A String",
   ],
+  "utilizationDetails": { # The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.
+    "externalIpv6InstanceUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range.
+      "totalAllocatedIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+      "totalFreeIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+    },
+    "externalIpv6LbUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB.
+      "totalAllocatedIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+      "totalFreeIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+    },
+    "internalIpv6Utilization": { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range.
+      "totalAllocatedIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+      "totalFreeIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+    },
+    "ipv4Utilizations": [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty.
+      { # The IPV4 utilization of a single IP range.
+        "rangeName": "A String", # Will be set for secondary range. Empty for primary IPv4 range.
+        "totalAllocatedIp": "A String",
+        "totalFreeIp": "A String",
+      },
+    ],
+  },
 }
 
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
@@ -819,7 +940,7 @@ 
Method Details

 

 
 

-    list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+    list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, views=None, x__xgafv=None)
   
Retrieves a list of subnetworks available to the specified project.
 
 Args:
@@ -830,6 +951,10 @@ 
Method Details

   orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
   pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
   returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
+  views: string, Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response.  (repeated)
+    Allowed values
+      DEFAULT - 
+      WITH_UTILIZATION - Utilization data is included in the response.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -895,6 +1020,45 @@ 
Method Details

       "systemReservedInternalIpv6Ranges": [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use.
         "A String",
       ],
+      "utilizationDetails": { # The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.
+        "externalIpv6InstanceUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range.
+          "totalAllocatedIp": {
+            "high": "A String",
+            "low": "A String",
+          },
+          "totalFreeIp": {
+            "high": "A String",
+            "low": "A String",
+          },
+        },
+        "externalIpv6LbUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB.
+          "totalAllocatedIp": {
+            "high": "A String",
+            "low": "A String",
+          },
+          "totalFreeIp": {
+            "high": "A String",
+            "low": "A String",
+          },
+        },
+        "internalIpv6Utilization": { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range.
+          "totalAllocatedIp": {
+            "high": "A String",
+            "low": "A String",
+          },
+          "totalFreeIp": {
+            "high": "A String",
+            "low": "A String",
+          },
+        },
+        "ipv4Utilizations": [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty.
+          { # The IPV4 utilization of a single IP range.
+            "rangeName": "A String", # Will be set for secondary range. Empty for primary IPv4 range.
+            "totalAllocatedIp": "A String",
+            "totalFreeIp": "A String",
+          },
+        ],
+      },
     },
   ],
   "kind": "compute#subnetworkList", # [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.
@@ -1081,6 +1245,45 @@ 
Method Details

   "systemReservedInternalIpv6Ranges": [ # Output only. [Output Only] The array of internal IPv6 network ranges reserved from the subnetwork's internal IPv6 range for system use.
     "A String",
   ],
+  "utilizationDetails": { # The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range. # Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.
+    "externalIpv6InstanceUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range.
+      "totalAllocatedIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+      "totalFreeIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+    },
+    "externalIpv6LbUtilization": { # The IPV6 utilization of a single IP range. # Utilizations of external IPV6 IP range for NetLB.
+      "totalAllocatedIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+      "totalFreeIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+    },
+    "internalIpv6Utilization": { # The IPV6 utilization of a single IP range. # Utilizations of internal IPV6 IP range.
+      "totalAllocatedIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+      "totalFreeIp": {
+        "high": "A String",
+        "low": "A String",
+      },
+    },
+    "ipv4Utilizations": [ # Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty.
+      { # The IPV4 utilization of a single IP range.
+        "rangeName": "A String", # Will be set for secondary range. Empty for primary IPv4 range.
+        "totalAllocatedIp": "A String",
+        "totalFreeIp": "A String",
+      },
+    ],
+  },
 }
 
   drainTimeoutSeconds: integer, The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.
diff --git a/docs/dyn/compute_v1.urlMaps.html b/docs/dyn/compute_v1.urlMaps.html
index 82d5204005b..44a11874df1 100644
--- a/docs/dyn/compute_v1.urlMaps.html
+++ b/docs/dyn/compute_v1.urlMaps.html
@@ -191,6 +191,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -339,6 +340,7 @@ 
Method Details

                 },
                 "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                   "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                  "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
                 },
                 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                   "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -478,6 +480,7 @@ 
Method Details

                     },
                     "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                       "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                      "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
                     },
                     "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                       "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -659,6 +662,7 @@ 
Method Details

                     },
                     "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                       "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                      "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
                     },
                     "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                       "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -984,6 +988,7 @@ 
Method Details

     },
     "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
       "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+      "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
     },
     "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
       "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1132,6 +1137,7 @@ 
Method Details

         },
         "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
           "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+          "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
         },
         "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
           "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1271,6 +1277,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1452,6 +1459,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1598,6 +1606,7 @@ 
Method Details

     },
     "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
       "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+      "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
     },
     "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
       "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1746,6 +1755,7 @@ 
Method Details

         },
         "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
           "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+          "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
         },
         "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
           "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -1885,6 +1895,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -2066,6 +2077,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -2476,6 +2488,7 @@ 
Method Details

         },
         "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
           "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+          "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
         },
         "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
           "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -2624,6 +2637,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -2763,6 +2777,7 @@ 
Method Details

                 },
                 "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                   "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                  "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
                 },
                 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                   "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -2944,6 +2959,7 @@ 
Method Details

                 },
                 "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                   "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                  "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
                 },
                 "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                   "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3120,6 +3136,7 @@ 
Method Details

     },
     "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
       "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+      "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
     },
     "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
       "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3268,6 +3285,7 @@ 
Method Details

         },
         "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
           "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+          "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
         },
         "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
           "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3407,6 +3425,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3588,6 +3607,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3851,6 +3871,7 @@ 
Method Details

     },
     "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
       "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+      "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
     },
     "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
       "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -3999,6 +4020,7 @@ 
Method Details

         },
         "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
           "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+          "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
         },
         "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
           "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -4138,6 +4160,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -4319,6 +4342,7 @@ 
Method Details

             },
             "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
               "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+              "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
             },
             "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
               "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -4586,6 +4610,7 @@ 
Method Details

       },
       "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
         "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+        "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
       },
       "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
         "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -4734,6 +4759,7 @@ 
Method Details

           },
           "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
             "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+            "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
           },
           "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
             "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -4873,6 +4899,7 @@ 
Method Details

               },
               "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
               },
               "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
@@ -5054,6 +5081,7 @@ 
Method Details

               },
               "requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.
                 "backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service.
+                "mirrorPercent": 3.14, # The percentage of requests to be mirrored to `backend_service`.
               },
               "retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.
                 "numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.
diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json
index 79a020101f4..0a8f60a7eb4 100644
--- a/googleapiclient/discovery_cache/documents/compute.alpha.json
+++ b/googleapiclient/discovery_cache/documents/compute.alpha.json
@@ -21606,6 +21606,48 @@
 "https://www.googleapis.com/auth/compute"
 ]
 },
+"cancelRequestRemovePeering": {
+"description": "Cancel requests to remove a peering from the specified network. Applicable only for PeeringConnection with update_strategy=CONSENSUS. Cancels a request to remove a peering from the specified network.",
+"flatPath": "projects/{project}/global/networks/{network}/cancelRequestRemovePeering",
+"httpMethod": "POST",
+"id": "compute.networks.cancelRequestRemovePeering",
+"parameterOrder": [
+"project",
+"network"
+],
+"parameters": {
+"network": {
+"description": "Name of the network resource to remove peering from.",
+"location": "path",
+"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Project ID for this request.",
+"location": "path",
+"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+}
+},
+"path": "projects/{project}/global/networks/{network}/cancelRequestRemovePeering",
+"request": {
+"$ref": "NetworksCancelRequestRemovePeeringRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/compute"
+]
+},
 "delete": {
 "description": "Deletes the specified network.",
 "flatPath": "projects/{project}/global/networks/{network}",
@@ -24101,6 +24143,12 @@
 "pattern": "(securityPolicies/)?[0-9]{0,20}",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Indicates fields to be cleared as part of this request.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "locations/global/securityPolicies/{securityPolicy}",
@@ -24141,6 +24189,12 @@
 "pattern": "(securityPolicies/)?[0-9]{0,20}",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Indicates fields to be cleared as part of this request.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "locations/global/securityPolicies/{securityPolicy}/patchRule",
@@ -25024,7 +25078,8 @@
 ]
 },
 "moveDisk": {
-"description": "Moves a persistent disk from one zone to another.",
+"deprecated": true,
+"description": "Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.",
 "flatPath": "projects/{project}/moveDisk",
 "httpMethod": "POST",
 "id": "compute.projects.moveDisk",
@@ -52501,7 +52556,7 @@
 }
 }
 },
-"revision": "20250902",
+"revision": "20250909",
 "rootUrl": "https://compute.googleapis.com/",
 "schemas": {
 "AWSV4Signature": {
@@ -87150,13 +87205,17 @@ false
 "enum": [
 "DELETE_ACKNOWLEDGED",
 "DELETE_STATUS_UNSPECIFIED",
+"LOCAL_CANCEL_REQUESTED",
 "LOCAL_DELETE_REQUESTED",
+"PEER_CANCEL_REQUESTED",
 "PEER_DELETE_REQUESTED"
 ],
 "enumDescriptions": [
 "Both network admins have agreed this consensus peering connection can be deleted.",
 "",
+"The local network admin requested to cancel their delete request after DELETE_ACKNOWLEDGED.",
 "Network admin has requested deletion of this peering connection.",
+"The peer network admin requested to cancel their delete request after DELETE_ACKNOWLEDGED.",
 "The peer network admin has requested deletion of this peering connection."
 ],
 "type": "string"
@@ -88755,6 +88814,16 @@ false
 },
 "type": "object"
 },
+"NetworksCancelRequestRemovePeeringRequest": {
+"id": "NetworksCancelRequestRemovePeeringRequest",
+"properties": {
+"name": {
+"description": "Name of the peering, which should conform to RFC1035.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "NetworksGetEffectiveFirewallsResponse": {
 "id": "NetworksGetEffectiveFirewallsResponse",
 "properties": {
@@ -103101,6 +103170,10 @@ false
 "description": "IPv6 address of the interface inside Google Cloud Platform.",
 "type": "string"
 },
+"linkedCustomHardware": {
+"description": "The linked custom hardware resource. The URI of the custom hardware link attachment is where you will establish the BGP session from the Cloud Router. This link attachment must reside in the same subnetwork as the associated router interface.",
+"type": "string"
+},
 "managementType": {
 "description": "[Output Only] The resource that configures and manages this BGP peer. - MANAGED_BY_USER is the default value and can be managed by you or other users - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted. ",
 "enum": [
@@ -103870,6 +103943,10 @@ false
 "description": "IPv6 address of the local BGP interface.",
 "type": "string"
 },
+"linkedCustomHardware": {
+"description": "The URI of the linked custom hardware resource, CustomHardwareLinkAttachment. This CustomHardwareLinkAttachment resource is the one that will establish the BGP session from the Cloud Router.",
+"type": "string"
+},
 "linkedVpnTunnel": {
 "description": "URL of the VPN tunnel that this BGP peer controls.",
 "type": "string"
diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json
index 955cbe757e2..fb5215c1fb1 100644
--- a/googleapiclient/discovery_cache/documents/compute.beta.json
+++ b/googleapiclient/discovery_cache/documents/compute.beta.json
@@ -22201,6 +22201,12 @@
 "pattern": "(securityPolicies/)?[0-9]{0,20}",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Indicates fields to be cleared as part of this request.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "locations/global/securityPolicies/{securityPolicy}",
@@ -22241,6 +22247,12 @@
 "pattern": "(securityPolicies/)?[0-9]{0,20}",
 "required": true,
 "type": "string"
+},
+"updateMask": {
+"description": "Indicates fields to be cleared as part of this request.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
 "path": "locations/global/securityPolicies/{securityPolicy}/patchRule",
@@ -23124,7 +23136,8 @@
 ]
 },
 "moveDisk": {
-"description": "Moves a persistent disk from one zone to another.",
+"deprecated": true,
+"description": "Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.",
 "flatPath": "projects/{project}/moveDisk",
 "httpMethod": "POST",
 "id": "compute.projects.moveDisk",
@@ -45753,7 +45766,7 @@
 }
 }
 },
-"revision": "20250902",
+"revision": "20250909",
 "rootUrl": "https://compute.googleapis.com/",
 "schemas": {
 "AWSV4Signature": {
@@ -68795,6 +68808,13 @@ false
 "description": "[Output Only] Server-defined URL for the resource.",
 "type": "string"
 },
+"singleRegionProductionCriticalPeerLocations": {
+"description": "[Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "status": {
 "description": "[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. ",
 "enum": [
diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json
index 278a17e0565..c22ae95f047 100644
--- a/googleapiclient/discovery_cache/documents/compute.v1.json
+++ b/googleapiclient/discovery_cache/documents/compute.v1.json
@@ -20558,7 +20558,8 @@
 ]
 },
 "moveDisk": {
-"description": "Moves a persistent disk from one zone to another.",
+"deprecated": true,
+"description": "Starting September 29, 2025, you can't use the moveDisk API on new projects. To move a disk to a different region or zone, follow the steps in [Change the location of a disk](https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd). Projects that already use the moveDisk API can continue usage until September 29, 2026. Starting November 1, 2025, API responses will include a warning message in the response body about the upcoming deprecation. You can skip the message to continue using the service without interruption.",
 "flatPath": "projects/{project}/moveDisk",
 "httpMethod": "POST",
 "id": "compute.projects.moveDisk",
@@ -35508,6 +35509,20 @@
 "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
 "required": true,
 "type": "string"
+},
+"views": {
+"description": "Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. ",
+"enum": [
+"DEFAULT",
+"WITH_UTILIZATION"
+],
+"enumDescriptions": [
+"",
+"Utilization data is included in the response."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
 }
 },
 "path": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
@@ -35662,6 +35677,20 @@
 "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.",
 "location": "query",
 "type": "boolean"
+},
+"views": {
+"description": "Defines the extra views returned back in the subnetwork resource. Supported values: - WITH_UTILIZATION: Utilization data is included in the response. ",
+"enum": [
+"DEFAULT",
+"WITH_UTILIZATION"
+],
+"enumDescriptions": [
+"",
+"Utilization data is included in the response."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
 }
 },
 "path": "projects/{project}/regions/{region}/subnetworks",
@@ -40372,7 +40401,7 @@
 }
 }
 },
-"revision": "20250902",
+"revision": "20250909",
 "rootUrl": "https://compute.googleapis.com/",
 "schemas": {
 "AWSV4Signature": {
@@ -60915,6 +60944,13 @@ false
 "description": "[Output Only] Server-defined URL for the resource.",
 "type": "string"
 },
+"singleRegionProductionCriticalPeerLocations": {
+"description": "[Output Only] URLs of the other locations that can pair up with this location to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and iad-zone2-5467 are Single-Region 99.99% peer locations of each other.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "status": {
 "description": "[Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. ",
 "enum": [
@@ -61355,6 +61391,11 @@ false
 "format": "int32",
 "type": "integer"
 },
+"maxLagSize400Gbps": {
+"description": "[Output Only] The maximum number of 400 Gbps ports supported in a link aggregation group (LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed max_lag_size_400_gbps.",
+"format": "int32",
+"type": "integer"
+},
 "name": {
 "description": "[Output Only] Name of the resource.",
 "type": "string"
@@ -74233,6 +74274,11 @@ false
 "backendService": {
 "description": "The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. ",
 "type": "string"
+},
+"mirrorPercent": {
+"description": "The percentage of requests to be mirrored to `backend_service`.",
+"format": "double",
+"type": "number"
 }
 },
 "type": "object"
@@ -85168,6 +85214,11 @@ false
 },
 "readOnly": true,
 "type": "array"
+},
+"utilizationDetails": {
+"$ref": "SubnetworkUtilizationDetails",
+"description": "Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.",
+"readOnly": true
 }
 },
 "type": "object"
@@ -85583,6 +85634,64 @@ false
 },
 "type": "object"
 },
+"SubnetworkUtilizationDetails": {
+"description": "The current IP utilization of all subnetwork ranges. Contains the total number of allocated and free IPs in each range.",
+"id": "SubnetworkUtilizationDetails",
+"properties": {
+"externalIpv6InstanceUtilization": {
+"$ref": "SubnetworkUtilizationDetailsIPV6Utilization",
+"description": "Utilizations of external IPV6 IP range."
+},
+"externalIpv6LbUtilization": {
+"$ref": "SubnetworkUtilizationDetailsIPV6Utilization",
+"description": "Utilizations of external IPV6 IP range for NetLB."
+},
+"internalIpv6Utilization": {
+"$ref": "SubnetworkUtilizationDetailsIPV6Utilization",
+"description": "Utilizations of internal IPV6 IP range."
+},
+"ipv4Utilizations": {
+"description": "Utilizations of all IPV4 IP ranges. For primary ranges, the range name will be empty.",
+"items": {
+"$ref": "SubnetworkUtilizationDetailsIPV4Utilization"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"SubnetworkUtilizationDetailsIPV4Utilization": {
+"description": "The IPV4 utilization of a single IP range.",
+"id": "SubnetworkUtilizationDetailsIPV4Utilization",
+"properties": {
+"rangeName": {
+"description": "Will be set for secondary range. Empty for primary IPv4 range.",
+"type": "string"
+},
+"totalAllocatedIp": {
+"format": "int64",
+"type": "string"
+},
+"totalFreeIp": {
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"SubnetworkUtilizationDetailsIPV6Utilization": {
+"description": "The IPV6 utilization of a single IP range.",
+"id": "SubnetworkUtilizationDetailsIPV6Utilization",
+"properties": {
+"totalAllocatedIp": {
+"$ref": "Uint128"
+},
+"totalFreeIp": {
+"$ref": "Uint128"
+}
+},
+"type": "object"
+},
 "SubnetworksExpandIpCidrRangeRequest": {
 "id": "SubnetworksExpandIpCidrRangeRequest",
 "properties": {

From b6be6cb309d31288787685d4e01a43bd6277556f Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:07 +0000
Subject: [PATCH 10/26] feat(connectors): update the api

#### connectors:v2

The following keys were added:
- schemas.Tool.properties.annotations.$ref (Total Keys: 1)
- schemas.ToolAnnotations (Total Keys: 6)
---
 ....projects.locations.connections.tools.html |  7 ++++
 .../documents/connectors.v2.json              | 33 ++++++++++++++++++-
 2 files changed, 39 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/connectors_v2.projects.locations.connections.tools.html b/docs/dyn/connectors_v2.projects.locations.connections.tools.html
index c0938adf23f..cd68df125bb 100644
--- a/docs/dyn/connectors_v2.projects.locations.connections.tools.html
+++ b/docs/dyn/connectors_v2.projects.locations.connections.tools.html
@@ -142,6 +142,13 @@ 
Method Details

   "nextPageToken": "A String", # Next page token.
   "tools": [ # List of available tools.
     { # Message representing a single tool.
+      "annotations": { # ToolAnnotations holds annotations for a tool. # Annotations for the tool.
+        "destructiveHint": True or False, # If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. (This property is meaningful only when `read_only_hint == false`)
+        "idempotentHint": True or False, # If true, calling the tool repeatedly with the same arguments will have no additional effect on the environment. (This property is meaningful only when `read_only_hint == false`)
+        "openWorldHint": True or False, # If true, this tool may interact with an "open world" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.
+        "readOnlyHint": True or False, # If true, the tool does not modify its environment.
+        "title": "A String", # A human-readable title for the tool.
+      },
       "dependsOn": [ # List of tool names that this tool depends on.
         "A String",
       ],
diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json
index 51c3f92b730..3c137b63107 100644
--- a/googleapiclient/discovery_cache/documents/connectors.v2.json
+++ b/googleapiclient/discovery_cache/documents/connectors.v2.json
@@ -769,7 +769,7 @@
 }
 }
 },
-"revision": "20250826",
+"revision": "20250917",
 "rootUrl": "https://connectors.googleapis.com/",
 "schemas": {
 "AccessCredentials": {
@@ -2710,6 +2710,10 @@ false
 "description": "Message representing a single tool.",
 "id": "Tool",
 "properties": {
+"annotations": {
+"$ref": "ToolAnnotations",
+"description": "Annotations for the tool."
+},
 "dependsOn": {
 "description": "List of tool names that this tool depends on.",
 "items": {
@@ -2736,6 +2740,33 @@ false
 },
 "type": "object"
 },
+"ToolAnnotations": {
+"description": "ToolAnnotations holds annotations for a tool.",
+"id": "ToolAnnotations",
+"properties": {
+"destructiveHint": {
+"description": "If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. (This property is meaningful only when `read_only_hint == false`)",
+"type": "boolean"
+},
+"idempotentHint": {
+"description": "If true, calling the tool repeatedly with the same arguments will have no additional effect on the environment. (This property is meaningful only when `read_only_hint == false`)",
+"type": "boolean"
+},
+"openWorldHint": {
+"description": "If true, this tool may interact with an \"open world\" of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not.",
+"type": "boolean"
+},
+"readOnlyHint": {
+"description": "If true, the tool does not modify its environment.",
+"type": "boolean"
+},
+"title": {
+"description": "A human-readable title for the tool.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "UpdateEntitiesWithConditionsResponse": {
 "description": "Response message for EntityService.UpdateEntitiesWithConditions",
 "id": "UpdateEntitiesWithConditionsResponse",

From bfd0bca858052c8dc84584c103a3b4bb1494757a Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:07 +0000
Subject: [PATCH 11/26] feat(dataform): update the api

#### dataform:v1beta1

The following keys were deleted:
- resources.projects.resources.locations.resources.folders.methods.getIamPolicy (Total Keys: 14)
- resources.projects.resources.locations.resources.folders.methods.setIamPolicy (Total Keys: 12)
- resources.projects.resources.locations.resources.folders.methods.testIamPermissions (Total Keys: 12)
- resources.projects.resources.locations.resources.repositories.methods.getIamPolicy (Total Keys: 14)
- resources.projects.resources.locations.resources.repositories.methods.setIamPolicy (Total Keys: 12)
- resources.projects.resources.locations.resources.repositories.methods.testIamPermissions (Total Keys: 12)
- resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.getIamPolicy (Total Keys: 14)
- resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.setIamPolicy (Total Keys: 12)
- resources.projects.resources.locations.resources.repositories.resources.workspaces.methods.testIamPermissions (Total Keys: 12)
- resources.projects.resources.locations.resources.teamFolders.methods.getIamPolicy (Total Keys: 14)
- resources.projects.resources.locations.resources.teamFolders.methods.setIamPolicy (Total Keys: 12)
- resources.projects.resources.locations.resources.teamFolders.methods.testIamPermissions (Total Keys: 12)
- schemas.Binding (Total Keys: 6)
- schemas.Expr (Total Keys: 4)
- schemas.Policy (Total Keys: 6)
- schemas.SetIamPolicyRequest (Total Keys: 3)
- schemas.TestIamPermissionsRequest (Total Keys: 4)
- schemas.TestIamPermissionsResponse (Total Keys: 4)
---
 .../dataform_v1beta1.projects.locations.html  |  10 -
 ...beta1.projects.locations.repositories.html | 132 -----
 ...cts.locations.repositories.workspaces.html | 132 -----
 .../documents/dataform.v1beta1.json           | 478 +-----------------
 4 files changed, 1 insertion(+), 751 deletions(-)

diff --git a/docs/dyn/dataform_v1beta1.projects.locations.html b/docs/dyn/dataform_v1beta1.projects.locations.html
index d59b6f92574..acae11f8ec4 100644
--- a/docs/dyn/dataform_v1beta1.projects.locations.html
+++ b/docs/dyn/dataform_v1beta1.projects.locations.html
@@ -74,11 +74,6 @@
 
 
Dataform API . projects . locations

 
Instance Methods

-

-  folders()
-

-
Returns the folders Resource.

-
 

   operations()
 

@@ -89,11 +84,6 @@ 
Instance Methods

 

 
Returns the repositories Resource.

 
-

-  teamFolders()
-

-
Returns the teamFolders Resource.

-
 

   close()

 
Close httplib2 connections.

diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html
index 59f6d05cf6a..72fd845ac5e 100644
--- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.html
+++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.html
@@ -126,9 +126,6 @@ 
Instance Methods

 

   get(name, x__xgafv=None)

 
Fetches a single Repository.

-

-  getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

-
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

 

   list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

 
Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.

@@ -147,12 +144,6 @@ 
Instance Methods

 

   readFile(name, commitSha=None, path=None, x__xgafv=None)

 
Returns the contents of a file (inside a Repository). The Repository must not have a value for `git_remote_settings.url`.

-

-  setIamPolicy(resource, body=None, x__xgafv=None)

-
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

-

-  testIamPermissions(resource, body=None, x__xgafv=None)

-
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

 
Method Details

 

     close()
@@ -436,41 +427,6 @@ 
Method Details

 }

 

 
-

-    getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
-  
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
-
-Args:
-  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
-  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
-  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-    { # Associates `members`, or principals, with a `role`.
-      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
-      },
-      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
-        "A String",
-      ],
-      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
-    },
-  ],
-  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
-  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-}

-

-
 

     list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
   
Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.
@@ -691,92 +647,4 @@ 
Method Details

 }

 

 
-

-    setIamPolicy(resource, body=None, x__xgafv=None)
-  
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
-
-Args:
-  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for `SetIamPolicy` method.
-  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
-    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-      { # Associates `members`, or principals, with a `role`.
-        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
-        },
-        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
-          "A String",
-        ],
-        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
-      },
-    ],
-    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
-    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-  },
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
-  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-    { # Associates `members`, or principals, with a `role`.
-      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
-      },
-      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
-        "A String",
-      ],
-      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
-    },
-  ],
-  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
-  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-}

-

-
-

-    testIamPermissions(resource, body=None, x__xgafv=None)
-  
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
-
-Args:
-  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for `TestIamPermissions` method.
-  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
-    "A String",
-  ],
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for `TestIamPermissions` method.
-  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
-    "A String",
-  ],
-}

-

-
 
\ No newline at end of file
diff --git a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html
index 1f72eb286e4..0b0ee0ac920 100644
--- a/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html
+++ b/docs/dyn/dataform_v1beta1.projects.locations.repositories.workspaces.html
@@ -98,9 +98,6 @@ 
Instance Methods

 

   get(name, x__xgafv=None)

 
Fetches a single Workspace.

-

-  getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

-
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

 

   installNpmPackages(workspace, body=None, x__xgafv=None)

 
Installs dependency NPM packages (inside a Workspace).

@@ -149,12 +146,6 @@ 
Instance Methods

 

   searchFiles_next()

 
Retrieves the next page of results.

-

-  setIamPolicy(resource, body=None, x__xgafv=None)

-
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

-

-  testIamPermissions(resource, body=None, x__xgafv=None)

-
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

 

   writeFile(workspace, body=None, x__xgafv=None)

 
Writes to a file (inside a Workspace).

@@ -340,41 +331,6 @@ 
Method Details

 }

 

 
-

-    getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
-  
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
-
-Args:
-  resource: string, REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
-  options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
-  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-    { # Associates `members`, or principals, with a `role`.
-      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
-      },
-      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
-        "A String",
-      ],
-      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
-    },
-  ],
-  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
-  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-}

-

-
 

     installNpmPackages(workspace, body=None, x__xgafv=None)
   
Installs dependency NPM packages (inside a Workspace).
@@ -767,94 +723,6 @@ 
Method Details

         

 

 
-

-    setIamPolicy(resource, body=None, x__xgafv=None)
-  
Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
-
-Args:
-  resource: string, REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for `SetIamPolicy` method.
-  "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
-    "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-      { # Associates `members`, or principals, with a `role`.
-        "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-          "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-          "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-          "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
-        },
-        "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
-          "A String",
-        ],
-        "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
-      },
-    ],
-    "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
-    "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-  },
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
-  "bindings": [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
-    { # Associates `members`, or principals, with a `role`.
-      "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-        "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
-        "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
-        "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
-        "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
-      },
-      "members": [ # Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.
-        "A String",
-      ],
-      "role": "A String", # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).
-    },
-  ],
-  "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
-  "version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
-}

-

-
-

-    testIamPermissions(resource, body=None, x__xgafv=None)
-  
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
-
-Args:
-  resource: string, REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for `TestIamPermissions` method.
-  "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
-    "A String",
-  ],
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for `TestIamPermissions` method.
-  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
-    "A String",
-  ],
-}

-

-
 

     writeFile(workspace, body=None, x__xgafv=None)
   
Writes to a file (inside a Workspace).
diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json
index b40b14d8526..725713c663d 100644
--- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json
@@ -248,100 +248,6 @@
 }
 },
 "resources": {
-"folders": {
-"methods": {
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:getIamPolicy",
-"httpMethod": "GET",
-"id": "dataform.projects.locations.folders.getIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:getIamPolicy",
-"response": {
-"$ref": "Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:setIamPolicy",
-"httpMethod": "POST",
-"id": "dataform.projects.locations.folders.setIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "SetIamPolicyRequest"
-},
-"response": {
-"$ref": "Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/folders/{foldersId}:testIamPermissions",
-"httpMethod": "POST",
-"id": "dataform.projects.locations.folders.testIamPermissions",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/folders/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:testIamPermissions",
-"request": {
-"$ref": "TestIamPermissionsRequest"
-},
-"response": {
-"$ref": "TestIamPermissionsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-}
-},
 "operations": {
 "methods": {
 "cancel": {
@@ -680,38 +586,6 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:getIamPolicy",
-"httpMethod": "GET",
-"id": "dataform.projects.locations.repositories.getIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:getIamPolicy",
-"response": {
-"$ref": "Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "list": {
 "description": "Lists Repositories in a given project and location. **Note:** *This method can return repositories not shown in the [Dataform UI](https://console.cloud.google.com/bigquery/dataform)*.",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories",
@@ -876,64 +750,6 @@
 "https://www.googleapis.com/auth/bigquery",
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-},
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:setIamPolicy",
-"httpMethod": "POST",
-"id": "dataform.projects.locations.repositories.setIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "SetIamPolicyRequest"
-},
-"response": {
-"$ref": "Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}:testIamPermissions",
-"httpMethod": "POST",
-"id": "dataform.projects.locations.repositories.testIamPermissions",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:testIamPermissions",
-"request": {
-"$ref": "TestIamPermissionsRequest"
-},
-"response": {
-"$ref": "TestIamPermissionsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
 }
 },
 "resources": {
@@ -1812,38 +1628,6 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:getIamPolicy",
-"httpMethod": "GET",
-"id": "dataform.projects.locations.repositories.workspaces.getIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:getIamPolicy",
-"response": {
-"$ref": "Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "installNpmPackages": {
 "description": "Installs dependency NPM packages (inside a Workspace).",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:installNpmPackages",
@@ -2272,64 +2056,6 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:setIamPolicy",
-"httpMethod": "POST",
-"id": "dataform.projects.locations.repositories.workspaces.setIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "SetIamPolicyRequest"
-},
-"response": {
-"$ref": "Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:testIamPermissions",
-"httpMethod": "POST",
-"id": "dataform.projects.locations.repositories.workspaces.testIamPermissions",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:testIamPermissions",
-"request": {
-"$ref": "TestIamPermissionsRequest"
-},
-"response": {
-"$ref": "TestIamPermissionsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
 "writeFile": {
 "description": "Writes to a file (inside a Workspace).",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}:writeFile",
@@ -2362,107 +2088,13 @@
 }
 }
 }
-},
-"teamFolders": {
-"methods": {
-"getIamPolicy": {
-"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:getIamPolicy",
-"httpMethod": "GET",
-"id": "dataform.projects.locations.teamFolders.getIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"options.requestedPolicyVersion": {
-"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:getIamPolicy",
-"response": {
-"$ref": "Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"setIamPolicy": {
-"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:setIamPolicy",
-"httpMethod": "POST",
-"id": "dataform.projects.locations.teamFolders.setIamPolicy",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:setIamPolicy",
-"request": {
-"$ref": "SetIamPolicyRequest"
-},
-"response": {
-"$ref": "Policy"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-},
-"testIamPermissions": {
-"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
-"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/teamFolders/{teamFoldersId}:testIamPermissions",
-"httpMethod": "POST",
-"id": "dataform.projects.locations.teamFolders.testIamPermissions",
-"parameterOrder": [
-"resource"
-],
-"parameters": {
-"resource": {
-"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/teamFolders/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta1/{+resource}:testIamPermissions",
-"request": {
-"$ref": "TestIamPermissionsRequest"
-},
-"response": {
-"$ref": "TestIamPermissionsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/bigquery",
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-}
 }
 }
 }
 }
 }
 },
-"revision": "20250907",
+"revision": "20250917",
 "rootUrl": "https://dataform.googleapis.com/",
 "schemas": {
 "ActionErrorTable": {
@@ -2594,28 +2226,6 @@
 },
 "type": "object"
 },
-"Binding": {
-"description": "Associates `members`, or principals, with a `role`.",
-"id": "Binding",
-"properties": {
-"condition": {
-"$ref": "Expr",
-"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
-},
-"members": {
-"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
-"items": {
-"type": "string"
-},
-"type": "array"
-},
-"role": {
-"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
-"type": "string"
-}
-},
-"type": "object"
-},
 "CancelOperationRequest": {
 "description": "The request message for Operations.CancelOperation.",
 "id": "CancelOperationRequest",
@@ -3134,29 +2744,6 @@
 },
 "type": "object"
 },
-"Expr": {
-"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
-"id": "Expr",
-"properties": {
-"description": {
-"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
-"type": "string"
-},
-"expression": {
-"description": "Textual representation of an expression in Common Expression Language syntax.",
-"type": "string"
-},
-"location": {
-"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
-"type": "string"
-},
-"title": {
-"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
-"type": "string"
-}
-},
-"type": "object"
-},
 "FetchFileDiffResponse": {
 "description": "`FetchFileDiff` response message.",
 "id": "FetchFileDiffResponse",
@@ -3912,30 +3499,6 @@
 },
 "type": "object"
 },
-"Policy": {
-"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
-"id": "Policy",
-"properties": {
-"bindings": {
-"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
-"items": {
-"$ref": "Binding"
-},
-"type": "array"
-},
-"etag": {
-"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
-"format": "byte",
-"type": "string"
-},
-"version": {
-"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
-"format": "int32",
-"type": "integer"
-}
-},
-"type": "object"
-},
 "PolicyName": {
 "description": "An internal name for an IAM policy, based on the resource to which the policy applies. Not to be confused with a resource's external full resource name. For more information on this distinction, see go/iam-full-resource-names.",
 "id": "PolicyName",
@@ -4453,17 +4016,6 @@
 },
 "type": "object"
 },
-"SetIamPolicyRequest": {
-"description": "Request message for `SetIamPolicy` method.",
-"id": "SetIamPolicyRequest",
-"properties": {
-"policy": {
-"$ref": "Policy",
-"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
-}
-},
-"type": "object"
-},
 "SimpleLoadMode": {
 "description": "Simple load definition",
 "id": "SimpleLoadMode",
@@ -4550,34 +4102,6 @@
 },
 "type": "object"
 },
-"TestIamPermissionsRequest": {
-"description": "Request message for `TestIamPermissions` method.",
-"id": "TestIamPermissionsRequest",
-"properties": {
-"permissions": {
-"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
-"items": {
-"type": "string"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"TestIamPermissionsResponse": {
-"description": "Response message for `TestIamPermissions` method.",
-"id": "TestIamPermissionsResponse",
-"properties": {
-"permissions": {
-"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
-"items": {
-"type": "string"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
 "UncommittedFileChange": {
 "description": "Represents the Git state of a file with uncommitted changes.",
 "id": "UncommittedFileChange",

From 51c34c4bfbc94ff6c6211dfc4a6dcb1785845930 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:08 +0000
Subject: [PATCH 12/26] feat(discoveryengine): update the api

#### discoveryengine:v1

The following keys were added:
- resources.projects.resources.locations.methods.setUpDataConnector (Total Keys: 28)
- resources.projects.resources.locations.resources.collections.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.collections.methods.getDataConnector (Total Keys: 11)
- resources.projects.resources.locations.resources.collections.methods.updateDataConnector (Total Keys: 15)
- schemas.GoogleCloudDiscoveryengineV1ActionConfig (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1AlertPolicyConfig (Total Keys: 9)
- schemas.GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata.properties.mimeType.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1BAPConfig (Total Keys: 4)
- schemas.GoogleCloudDiscoveryengineV1Collection (Total Keys: 7)
- schemas.GoogleCloudDiscoveryengineV1DataConnector (Total Keys: 105)
- schemas.GoogleCloudDiscoveryengineV1DeleteCollectionMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1DestinationConfig (Total Keys: 13)
- schemas.GoogleCloudDiscoveryengineV1Engine.properties.configurableBillingApproach.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1IdentityScheduleConfig (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1Project.properties.customerProvidedConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1ProvisionProjectRequestSaasParams.properties.isBiz.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1Tenant (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.jsonParams.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.jsonParams.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaDestinationConfig.properties.jsonParams.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.configurableBillingApproach.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaProject.properties.customerProvidedConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.searchAddonSpec.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec.properties.allowedFieldNames (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.configurableBillingApproach.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaProject.properties.customerProvidedConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.searchAddonSpec.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec.properties.allowedFieldNames (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec (Total Keys: 5)

#### discoveryengine:v1alpha

The following keys were deleted:
- schemas.GoogleCloudNotebooklmV1alphaAudioOverview.properties.audio (Total Keys: 2)

The following keys were added:
- resources.projects.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.methods.setUpDataConnectorV2 (Total Keys: 16)
- schemas.ApiservingMediaRequestInfo.properties.physicalHeaders (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1ActionConfig (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1AlertPolicyConfig (Total Keys: 9)
- schemas.GoogleCloudDiscoveryengineV1BAPConfig (Total Keys: 4)
- schemas.GoogleCloudDiscoveryengineV1Collection (Total Keys: 7)
- schemas.GoogleCloudDiscoveryengineV1DataConnector (Total Keys: 105)
- schemas.GoogleCloudDiscoveryengineV1DeleteCollectionMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1DestinationConfig (Total Keys: 13)
- schemas.GoogleCloudDiscoveryengineV1Engine.properties.configurableBillingApproach.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1IdentityScheduleConfig (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1Project.properties.customerProvidedConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1Tenant (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata.properties.mimeType.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.jsonParams.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.jsonParams.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaDestinationConfig.properties.jsonParams.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.configurableBillingApproach.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaProject.properties.customerProvidedConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1alphaProvisionProjectRequestSaasParams.properties.isBiz.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.searchAddonSpec.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec.properties.allowedFieldNames (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.enableCreateAgentButton.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.configurableBillingApproach.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaProject.properties.customerProvidedConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.searchAddonSpec.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec.properties.allowedFieldNames (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec (Total Keys: 5)
- schemas.GoogleCloudNotebooklmV1alphaAudioOverview.properties.generationOptions.$ref (Total Keys: 1)

#### discoveryengine:v1beta

The following keys were added:
- schemas.GoogleCloudDiscoveryengineV1ActionConfig (Total Keys: 8)
- schemas.GoogleCloudDiscoveryengineV1AlertPolicyConfig (Total Keys: 9)
- schemas.GoogleCloudDiscoveryengineV1BAPConfig (Total Keys: 4)
- schemas.GoogleCloudDiscoveryengineV1Collection (Total Keys: 7)
- schemas.GoogleCloudDiscoveryengineV1DataConnector (Total Keys: 105)
- schemas.GoogleCloudDiscoveryengineV1DeleteCollectionMetadata (Total Keys: 6)
- schemas.GoogleCloudDiscoveryengineV1DestinationConfig (Total Keys: 13)
- schemas.GoogleCloudDiscoveryengineV1Engine.properties.configurableBillingApproach.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1IdentityScheduleConfig (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1Project.properties.customerProvidedConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1Tenant (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.jsonParams.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaDataConnectorSourceEntity.properties.jsonParams.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaDestinationConfig.properties.jsonParams.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.configurableBillingApproach.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaProject.properties.customerProvidedConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequest.properties.searchAddonSpec.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec.properties.allowedFieldNames (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec (Total Keys: 5)
- schemas.GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata.properties.mimeType.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.configurableBillingApproach.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaProject.properties.customerProvidedConfig.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig (Total Keys: 10)
- schemas.GoogleCloudDiscoveryengineV1betaProvisionProjectRequestSaasParams.properties.isBiz.type (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequest.properties.searchAddonSpec.$ref (Total Keys: 1)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec.properties.allowedFieldNames (Total Keys: 2)
- schemas.GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec (Total Keys: 5)
---
 docs/dyn/discoveryengine_v1.projects.html     |    1 +
 ...collections.dataStores.servingConfigs.html |    4 +-
 ...ations.collections.engines.assistants.html |    1 +
 ...rojects.locations.collections.engines.html |   15 +-
 ...ns.collections.engines.servingConfigs.html |    4 +-
 ...ine_v1.projects.locations.collections.html |  627 +++++++++
 ...s.locations.dataStores.servingConfigs.html |    4 +-
 ...discoveryengine_v1.projects.locations.html |  454 +++++++
 .../dyn/discoveryengine_v1alpha.projects.html |   85 ++
 ...collections.dataStores.servingConfigs.html |   26 +-
 ....collections.dataStores.widgetConfigs.html |    3 +-
 ...ations.collections.engines.assistants.html |    1 +
 ...rojects.locations.collections.engines.html |   21 +-
 ...ns.collections.engines.servingConfigs.html |   26 +-
 ...ons.collections.engines.widgetConfigs.html |    3 +-
 ...1alpha.projects.locations.collections.html |   54 +-
 ...s.locations.dataStores.servingConfigs.html |   26 +-
 ...ts.locations.dataStores.widgetConfigs.html |    3 +-
 ...1alpha.projects.locations.evaluations.html |   30 +-
 ...veryengine_v1alpha.projects.locations.html |  255 +++-
 ...ts.locations.notebooks.audioOverviews.html |   11 +-
 ....projects.locations.notebooks.sources.html |    1 +
 docs/dyn/discoveryengine_v1beta.projects.html |    1 +
 ...collections.dataStores.servingConfigs.html |   26 +-
 ...ations.collections.engines.assistants.html |    1 +
 ...rojects.locations.collections.engines.html |   21 +-
 ...ns.collections.engines.servingConfigs.html |   26 +-
 ...s.locations.dataStores.servingConfigs.html |   26 +-
 ...v1beta.projects.locations.evaluations.html |   30 +-
 .../documents/discoveryengine.v1.json         | 1145 ++++++++++++++++-
 .../documents/discoveryengine.v1alpha.json    | 1078 +++++++++++++++-
 .../documents/discoveryengine.v1beta.json     | 1006 ++++++++++++++-
 32 files changed, 4862 insertions(+), 153 deletions(-)

diff --git a/docs/dyn/discoveryengine_v1.projects.html b/docs/dyn/discoveryengine_v1.projects.html
index 29423e4cde3..70b0d5bd84a 100644
--- a/docs/dyn/discoveryengine_v1.projects.html
+++ b/docs/dyn/discoveryengine_v1.projects.html
@@ -110,6 +110,7 @@ 
Method Details

   "dataUseTermsVersion": "A String", # Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.
   "saasParams": { # Parameters for Agentspace. # Optional. Parameters for Agentspace.
     "acceptBizQos": True or False, # Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].
+    "isBiz": True or False, # Optional. Indicates if the current request is for Biz edition (= true) or not (= false).
   },
 }
 
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
index cd4332e1562..f541bb9fd73 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
@@ -1127,7 +1127,7 @@ 
Method Details

     "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -1516,7 +1516,7 @@ 
Method Details

     "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html
index f2056c0a6a9..4f34855f041 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.assistants.html
@@ -360,6 +360,7 @@ 
Method Details

                 "documentMetadata": { # Document metadata. # Document metadata.
                   "document": "A String", # Document resource name.
                   "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.
+                  "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.
                   "pageIdentifier": "A String", # Page identifier.
                   "title": "A String", # Title.
                   "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
index 14366359c82..4fc6638dffe 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
@@ -163,13 +163,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -298,13 +299,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -374,13 +376,14 @@ 
Method Details

       "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
         "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
       },
+      "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
       "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
       "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
         "A String",
       ],
       "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
       "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-      "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+      "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
         "a_key": "A String",
       },
       "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -457,13 +460,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -522,13 +526,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
index 599fc69f56d..95d031e6c48 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html
@@ -1127,7 +1127,7 @@ 
Method Details

     "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -1516,7 +1516,7 @@ 
Method Details

     "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.html
index e4e18986714..dc8009f14ba 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.html
@@ -97,10 +97,637 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  delete(name, x__xgafv=None)

+
Deletes a Collection.

+

+  getDataConnector(name, x__xgafv=None)

+
Gets the DataConnector. DataConnector is a singleton resource for each Collection.

+

+  updateDataConnector(name, body=None, updateMask=None, x__xgafv=None)

+
Updates a DataConnector.

 
Method Details

 

     close()
   
Close httplib2 connections.

 

 
+

+    delete(name, x__xgafv=None)
+  
Deletes a Collection.
+
+Args:
+  name: string, Required. The full resource name of the Collection, in the format of `projects/{project}/locations/{location}/collections/{collection}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    getDataConnector(name, x__xgafv=None)
+  
Gets the DataConnector. DataConnector is a singleton resource for each Collection.
+
+Args:
+  name: string, Required. Full resource name of DataConnector, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.
+  "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
+  "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions.
+    "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.
+      "a_key": "", # Properties of the object.
+    },
+    "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions.
+    "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
+    "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
+  },
+  "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.
+  "alertPolicyConfigs": [ # Optional. The connector level alert config.
+    { # The connector level alert config.
+      "alertEnrollments": [ # Optional. The enrollment states of each alert.
+        { # The alert enrollment status.
+          "alertId": "A String", # Immutable. The id of an alert.
+          "enrollState": "A String", # Required. The enrollment status of a customer.
+        },
+      ],
+      "alertPolicyName": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    },
+  ],
+  "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs
+  "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection.
+    "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection.
+      "A String",
+    ],
+  },
+  "blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data.
+    "A String",
+  ],
+  "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
+    "A String",
+  ],
+  "connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
+  "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
+  "createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+  "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
+  "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
+    { # Defines target endpoints used to connect to third-party sources.
+      "destinations": [ # Optional. The destinations for the corresponding key.
+        { # Defines a target endpoint
+          "host": "A String", # Publicly routable host.
+          "port": 42, # Optional. Target port number accepted by the destination.
+        },
+      ],
+      "jsonParams": "A String", # Additional parameters for this destination config in json string format.
+      "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
+      "params": { # Optional. Additional parameters for this destination config in structured json format.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "endUserConfig": { # Any params and credentials used specifically for EUA connectors. # Optional. Any params and credentials used specifically for EUA connectors.
+    "additionalParams": { # Optional. Any additional parameters needed for EUA.
+      "a_key": "", # Properties of the object.
+    },
+    "authParams": { # Optional. Any authentication parameters specific to EUA connectors.
+      "a_key": "", # Properties of the object.
+    },
+    "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to.
+      "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team".
+      "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
+      "uri": "A String", # The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.
+    },
+  },
+  "entities": [ # List of entities from the connected data source to ingest.
+    { # Represents an entity in the data source. For example, the `Account` object in Salesforce.
+      "dataStore": "A String", # Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.
+      "entityName": "A String", # The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`
+      "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical.
+        "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
+        "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
+      },
+      "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
+      "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
+        "a_key": "A String",
+      },
+      "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
+        "a_key": "", # Properties of the object.
+      },
+      "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
+        "jsonSchema": "A String", # The JSON representation of the schema.
+        "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "structSchema": { # The structured representation of the schema.
+          "a_key": "", # Properties of the object.
+        },
+      },
+    },
+  ],
+  "errors": [ # Output only. The errors from initialization or from the latest connector run.
+    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  ],
+  "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.
+    "additionalParams": { # Optional. Any additional parameters needed for FEDERATED.
+      "a_key": "", # Properties of the object.
+    },
+    "authParams": { # Optional. Any authentication parameters specific to FEDERATED.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
+  "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+  "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.
+    "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day.
+      "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+      "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+      "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+      "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+      "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+      "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+        "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+      },
+      "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+      "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+    },
+    "refreshInterval": "A String", # Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+  },
+  "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+  "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+  "jsonParams": "A String", # Required data connector parameters in json string format.
+  "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
+  "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
+  "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
+  "name": "A String", # Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.
+  "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
+    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+  },
+  "params": { # Required data connector parameters in structured json format.
+    "a_key": "", # Properties of the object.
+  },
+  "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
+  "realtimeState": "A String", # Output only. real-time sync state
+  "realtimeSyncConfig": { # The configuration for realtime sync to store additional params for realtime sync. # Optional. The configuration for realtime sync.
+    "realtimeSyncSecret": "A String", # Optional. The ID of the Secret Manager secret used for webhook secret.
+    "streamingError": { # Streaming error details. # Optional. Streaming error details.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Optional. Error details.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "streamingErrorReason": "A String", # Optional. Streaming error.
+    },
+    "webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync.
+  },
+  "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+  "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
+    "A String",
+  ],
+  "state": "A String", # Output only. State of the connector.
+  "staticIpAddresses": [ # Output only. The static IP addresses used by this connector.
+    "A String",
+  ],
+  "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector.
+  "syncMode": "A String", # The data synchronization mode supported by the data connector.
+  "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated.
+}

+

+
+

+    updateDataConnector(name, body=None, updateMask=None, x__xgafv=None)
+  
Updates a DataConnector.
+
+Args:
+  name: string, Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.
+  "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
+  "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions.
+    "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.
+      "a_key": "", # Properties of the object.
+    },
+    "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions.
+    "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
+    "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
+  },
+  "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.
+  "alertPolicyConfigs": [ # Optional. The connector level alert config.
+    { # The connector level alert config.
+      "alertEnrollments": [ # Optional. The enrollment states of each alert.
+        { # The alert enrollment status.
+          "alertId": "A String", # Immutable. The id of an alert.
+          "enrollState": "A String", # Required. The enrollment status of a customer.
+        },
+      ],
+      "alertPolicyName": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    },
+  ],
+  "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs
+  "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection.
+    "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection.
+      "A String",
+    ],
+  },
+  "blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data.
+    "A String",
+  ],
+  "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
+    "A String",
+  ],
+  "connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
+  "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
+  "createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+  "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
+  "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
+    { # Defines target endpoints used to connect to third-party sources.
+      "destinations": [ # Optional. The destinations for the corresponding key.
+        { # Defines a target endpoint
+          "host": "A String", # Publicly routable host.
+          "port": 42, # Optional. Target port number accepted by the destination.
+        },
+      ],
+      "jsonParams": "A String", # Additional parameters for this destination config in json string format.
+      "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
+      "params": { # Optional. Additional parameters for this destination config in structured json format.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "endUserConfig": { # Any params and credentials used specifically for EUA connectors. # Optional. Any params and credentials used specifically for EUA connectors.
+    "additionalParams": { # Optional. Any additional parameters needed for EUA.
+      "a_key": "", # Properties of the object.
+    },
+    "authParams": { # Optional. Any authentication parameters specific to EUA connectors.
+      "a_key": "", # Properties of the object.
+    },
+    "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to.
+      "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team".
+      "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
+      "uri": "A String", # The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.
+    },
+  },
+  "entities": [ # List of entities from the connected data source to ingest.
+    { # Represents an entity in the data source. For example, the `Account` object in Salesforce.
+      "dataStore": "A String", # Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.
+      "entityName": "A String", # The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`
+      "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical.
+        "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
+        "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
+      },
+      "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
+      "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
+        "a_key": "A String",
+      },
+      "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
+        "a_key": "", # Properties of the object.
+      },
+      "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
+        "jsonSchema": "A String", # The JSON representation of the schema.
+        "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "structSchema": { # The structured representation of the schema.
+          "a_key": "", # Properties of the object.
+        },
+      },
+    },
+  ],
+  "errors": [ # Output only. The errors from initialization or from the latest connector run.
+    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  ],
+  "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.
+    "additionalParams": { # Optional. Any additional parameters needed for FEDERATED.
+      "a_key": "", # Properties of the object.
+    },
+    "authParams": { # Optional. Any authentication parameters specific to FEDERATED.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
+  "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+  "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.
+    "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day.
+      "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+      "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+      "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+      "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+      "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+      "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+        "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+      },
+      "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+      "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+    },
+    "refreshInterval": "A String", # Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+  },
+  "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+  "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+  "jsonParams": "A String", # Required data connector parameters in json string format.
+  "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
+  "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
+  "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
+  "name": "A String", # Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.
+  "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
+    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+  },
+  "params": { # Required data connector parameters in structured json format.
+    "a_key": "", # Properties of the object.
+  },
+  "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
+  "realtimeState": "A String", # Output only. real-time sync state
+  "realtimeSyncConfig": { # The configuration for realtime sync to store additional params for realtime sync. # Optional. The configuration for realtime sync.
+    "realtimeSyncSecret": "A String", # Optional. The ID of the Secret Manager secret used for webhook secret.
+    "streamingError": { # Streaming error details. # Optional. Streaming error details.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Optional. Error details.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "streamingErrorReason": "A String", # Optional. Streaming error.
+    },
+    "webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync.
+  },
+  "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+  "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
+    "A String",
+  ],
+  "state": "A String", # Output only. State of the connector.
+  "staticIpAddresses": [ # Output only. The static IP addresses used by this connector.
+    "A String",
+  ],
+  "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector.
+  "syncMode": "A String", # The data synchronization mode supported by the data connector.
+  "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated.
+}
+
+  updateMask: string, Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.
+  "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
+  "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions.
+    "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.
+      "a_key": "", # Properties of the object.
+    },
+    "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions.
+    "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
+    "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
+  },
+  "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.
+  "alertPolicyConfigs": [ # Optional. The connector level alert config.
+    { # The connector level alert config.
+      "alertEnrollments": [ # Optional. The enrollment states of each alert.
+        { # The alert enrollment status.
+          "alertId": "A String", # Immutable. The id of an alert.
+          "enrollState": "A String", # Required. The enrollment status of a customer.
+        },
+      ],
+      "alertPolicyName": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    },
+  ],
+  "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs
+  "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection.
+    "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection.
+      "A String",
+    ],
+  },
+  "blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data.
+    "A String",
+  ],
+  "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
+    "A String",
+  ],
+  "connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
+  "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
+  "createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+  "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
+  "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
+    { # Defines target endpoints used to connect to third-party sources.
+      "destinations": [ # Optional. The destinations for the corresponding key.
+        { # Defines a target endpoint
+          "host": "A String", # Publicly routable host.
+          "port": 42, # Optional. Target port number accepted by the destination.
+        },
+      ],
+      "jsonParams": "A String", # Additional parameters for this destination config in json string format.
+      "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
+      "params": { # Optional. Additional parameters for this destination config in structured json format.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "endUserConfig": { # Any params and credentials used specifically for EUA connectors. # Optional. Any params and credentials used specifically for EUA connectors.
+    "additionalParams": { # Optional. Any additional parameters needed for EUA.
+      "a_key": "", # Properties of the object.
+    },
+    "authParams": { # Optional. Any authentication parameters specific to EUA connectors.
+      "a_key": "", # Properties of the object.
+    },
+    "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to.
+      "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team".
+      "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
+      "uri": "A String", # The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.
+    },
+  },
+  "entities": [ # List of entities from the connected data source to ingest.
+    { # Represents an entity in the data source. For example, the `Account` object in Salesforce.
+      "dataStore": "A String", # Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.
+      "entityName": "A String", # The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`
+      "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical.
+        "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
+        "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
+      },
+      "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
+      "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
+        "a_key": "A String",
+      },
+      "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
+        "a_key": "", # Properties of the object.
+      },
+      "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
+        "jsonSchema": "A String", # The JSON representation of the schema.
+        "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "structSchema": { # The structured representation of the schema.
+          "a_key": "", # Properties of the object.
+        },
+      },
+    },
+  ],
+  "errors": [ # Output only. The errors from initialization or from the latest connector run.
+    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  ],
+  "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.
+    "additionalParams": { # Optional. Any additional parameters needed for FEDERATED.
+      "a_key": "", # Properties of the object.
+    },
+    "authParams": { # Optional. Any authentication parameters specific to FEDERATED.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
+  "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+  "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.
+    "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day.
+      "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+      "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+      "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+      "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+      "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+      "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+        "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+      },
+      "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+      "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+    },
+    "refreshInterval": "A String", # Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+  },
+  "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+  "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+  "jsonParams": "A String", # Required data connector parameters in json string format.
+  "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
+  "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
+  "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
+  "name": "A String", # Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.
+  "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
+    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+  },
+  "params": { # Required data connector parameters in structured json format.
+    "a_key": "", # Properties of the object.
+  },
+  "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
+  "realtimeState": "A String", # Output only. real-time sync state
+  "realtimeSyncConfig": { # The configuration for realtime sync to store additional params for realtime sync. # Optional. The configuration for realtime sync.
+    "realtimeSyncSecret": "A String", # Optional. The ID of the Secret Manager secret used for webhook secret.
+    "streamingError": { # Streaming error details. # Optional. Streaming error details.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Optional. Error details.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "streamingErrorReason": "A String", # Optional. Streaming error.
+    },
+    "webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync.
+  },
+  "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+  "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
+    "A String",
+  ],
+  "state": "A String", # Output only. State of the connector.
+  "staticIpAddresses": [ # Output only. The static IP addresses used by this connector.
+    "A String",
+  ],
+  "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector.
+  "syncMode": "A String", # The data synchronization mode supported by the data connector.
+  "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated.
+}

+

+
 
\ No newline at end of file
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
index 1313b3d234a..01525eeabba 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html
@@ -1127,7 +1127,7 @@ 
Method Details

     "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -1516,7 +1516,7 @@ 
Method Details

     "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html
index b8beb26b1be..7466d4d389e 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.html
@@ -133,6 +133,12 @@ 
Instance Methods

 

   getCmekConfig(name, x__xgafv=None)

 
Gets the CmekConfig.

+

+  setUpDataConnector(parent, body=None, x__xgafv=None)

+
Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.

+

+  setUpDataConnectorV2(parent, body=None, collectionDisplayName=None, collectionId=None, x__xgafv=None)

+
Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.

 

   updateAclConfig(name, body=None, x__xgafv=None)

 
Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

@@ -200,6 +206,454 @@ 
Method Details

 }

 

 
+

+    setUpDataConnector(parent, body=None, x__xgafv=None)
+  
Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.
+
+Args:
+  parent: string, Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for DataConnectorService.SetUpDataConnector method.
+  "collectionDisplayName": "A String", # Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
+  "collectionId": "A String", # Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  "dataConnector": { # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. # Required. The DataConnector to initialize in the newly created Collection.
+    "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
+    "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions.
+      "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.
+        "a_key": "", # Properties of the object.
+      },
+      "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions.
+      "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
+      "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
+    },
+    "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.
+    "alertPolicyConfigs": [ # Optional. The connector level alert config.
+      { # The connector level alert config.
+        "alertEnrollments": [ # Optional. The enrollment states of each alert.
+          { # The alert enrollment status.
+            "alertId": "A String", # Immutable. The id of an alert.
+            "enrollState": "A String", # Required. The enrollment status of a customer.
+          },
+        ],
+        "alertPolicyName": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+      },
+    ],
+    "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs
+    "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection.
+      "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection.
+        "A String",
+      ],
+    },
+    "blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data.
+      "A String",
+    ],
+    "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
+      "A String",
+    ],
+    "connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
+    "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
+    "createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+    "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
+    "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
+      { # Defines target endpoints used to connect to third-party sources.
+        "destinations": [ # Optional. The destinations for the corresponding key.
+          { # Defines a target endpoint
+            "host": "A String", # Publicly routable host.
+            "port": 42, # Optional. Target port number accepted by the destination.
+          },
+        ],
+        "jsonParams": "A String", # Additional parameters for this destination config in json string format.
+        "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
+        "params": { # Optional. Additional parameters for this destination config in structured json format.
+          "a_key": "", # Properties of the object.
+        },
+      },
+    ],
+    "endUserConfig": { # Any params and credentials used specifically for EUA connectors. # Optional. Any params and credentials used specifically for EUA connectors.
+      "additionalParams": { # Optional. Any additional parameters needed for EUA.
+        "a_key": "", # Properties of the object.
+      },
+      "authParams": { # Optional. Any authentication parameters specific to EUA connectors.
+        "a_key": "", # Properties of the object.
+      },
+      "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to.
+        "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team".
+        "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
+        "uri": "A String", # The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.
+      },
+    },
+    "entities": [ # List of entities from the connected data source to ingest.
+      { # Represents an entity in the data source. For example, the `Account` object in Salesforce.
+        "dataStore": "A String", # Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.
+        "entityName": "A String", # The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`
+        "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical.
+          "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
+          "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
+        },
+        "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
+        "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
+          "a_key": "A String",
+        },
+        "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
+          "a_key": "", # Properties of the object.
+        },
+        "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
+          "jsonSchema": "A String", # The JSON representation of the schema.
+          "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+          "structSchema": { # The structured representation of the schema.
+            "a_key": "", # Properties of the object.
+          },
+        },
+      },
+    ],
+    "errors": [ # Output only. The errors from initialization or from the latest connector run.
+      { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+    ],
+    "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.
+      "additionalParams": { # Optional. Any additional parameters needed for FEDERATED.
+        "a_key": "", # Properties of the object.
+      },
+      "authParams": { # Optional. Any authentication parameters specific to FEDERATED.
+        "a_key": "", # Properties of the object.
+      },
+    },
+    "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
+    "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+    "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.
+      "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day.
+        "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+        "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+        "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+        "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+        "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+        "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+        "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+          "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+          "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+        },
+        "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+        "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+      },
+      "refreshInterval": "A String", # Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+    },
+    "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+    "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+    "jsonParams": "A String", # Required data connector parameters in json string format.
+    "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
+    "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
+    "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
+    "name": "A String", # Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.
+    "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
+      "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+      "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+      "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+      "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+      "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+      "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+        "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+      },
+      "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+      "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+    },
+    "params": { # Required data connector parameters in structured json format.
+      "a_key": "", # Properties of the object.
+    },
+    "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
+    "realtimeState": "A String", # Output only. real-time sync state
+    "realtimeSyncConfig": { # The configuration for realtime sync to store additional params for realtime sync. # Optional. The configuration for realtime sync.
+      "realtimeSyncSecret": "A String", # Optional. The ID of the Secret Manager secret used for webhook secret.
+      "streamingError": { # Streaming error details. # Optional. Streaming error details.
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Optional. Error details.
+          "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+          "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+            {
+              "a_key": "", # Properties of the object. Contains field @type with type URL.
+            },
+          ],
+          "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+        },
+        "streamingErrorReason": "A String", # Optional. Streaming error.
+      },
+      "webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync.
+    },
+    "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+    "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
+      "A String",
+    ],
+    "state": "A String", # Output only. State of the connector.
+    "staticIpAddresses": [ # Output only. The static IP addresses used by this connector.
+      "A String",
+    ],
+    "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector.
+    "syncMode": "A String", # The data synchronization mode supported by the data connector.
+    "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    setUpDataConnectorV2(parent, body=None, collectionDisplayName=None, collectionId=None, x__xgafv=None)
+  
Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.
+
+Args:
+  parent: string, Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.
+  "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
+  "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions.
+    "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.
+      "a_key": "", # Properties of the object.
+    },
+    "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions.
+    "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
+    "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
+  },
+  "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.
+  "alertPolicyConfigs": [ # Optional. The connector level alert config.
+    { # The connector level alert config.
+      "alertEnrollments": [ # Optional. The enrollment states of each alert.
+        { # The alert enrollment status.
+          "alertId": "A String", # Immutable. The id of an alert.
+          "enrollState": "A String", # Required. The enrollment status of a customer.
+        },
+      ],
+      "alertPolicyName": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    },
+  ],
+  "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs
+  "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection.
+    "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection.
+      "A String",
+    ],
+  },
+  "blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data.
+    "A String",
+  ],
+  "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
+    "A String",
+  ],
+  "connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
+  "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
+  "createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+  "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
+  "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
+    { # Defines target endpoints used to connect to third-party sources.
+      "destinations": [ # Optional. The destinations for the corresponding key.
+        { # Defines a target endpoint
+          "host": "A String", # Publicly routable host.
+          "port": 42, # Optional. Target port number accepted by the destination.
+        },
+      ],
+      "jsonParams": "A String", # Additional parameters for this destination config in json string format.
+      "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
+      "params": { # Optional. Additional parameters for this destination config in structured json format.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "endUserConfig": { # Any params and credentials used specifically for EUA connectors. # Optional. Any params and credentials used specifically for EUA connectors.
+    "additionalParams": { # Optional. Any additional parameters needed for EUA.
+      "a_key": "", # Properties of the object.
+    },
+    "authParams": { # Optional. Any authentication parameters specific to EUA connectors.
+      "a_key": "", # Properties of the object.
+    },
+    "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to.
+      "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team".
+      "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
+      "uri": "A String", # The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.
+    },
+  },
+  "entities": [ # List of entities from the connected data source to ingest.
+    { # Represents an entity in the data source. For example, the `Account` object in Salesforce.
+      "dataStore": "A String", # Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.
+      "entityName": "A String", # The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`
+      "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical.
+        "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
+        "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
+      },
+      "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
+      "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
+        "a_key": "A String",
+      },
+      "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
+        "a_key": "", # Properties of the object.
+      },
+      "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
+        "jsonSchema": "A String", # The JSON representation of the schema.
+        "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "structSchema": { # The structured representation of the schema.
+          "a_key": "", # Properties of the object.
+        },
+      },
+    },
+  ],
+  "errors": [ # Output only. The errors from initialization or from the latest connector run.
+    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  ],
+  "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.
+    "additionalParams": { # Optional. Any additional parameters needed for FEDERATED.
+      "a_key": "", # Properties of the object.
+    },
+    "authParams": { # Optional. Any authentication parameters specific to FEDERATED.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
+  "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+  "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.
+    "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day.
+      "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+      "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+      "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+      "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+      "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+      "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+        "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+      },
+      "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+      "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+    },
+    "refreshInterval": "A String", # Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+  },
+  "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+  "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+  "jsonParams": "A String", # Required data connector parameters in json string format.
+  "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
+  "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
+  "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
+  "name": "A String", # Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.
+  "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
+    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+  },
+  "params": { # Required data connector parameters in structured json format.
+    "a_key": "", # Properties of the object.
+  },
+  "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
+  "realtimeState": "A String", # Output only. real-time sync state
+  "realtimeSyncConfig": { # The configuration for realtime sync to store additional params for realtime sync. # Optional. The configuration for realtime sync.
+    "realtimeSyncSecret": "A String", # Optional. The ID of the Secret Manager secret used for webhook secret.
+    "streamingError": { # Streaming error details. # Optional. Streaming error details.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Optional. Error details.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "streamingErrorReason": "A String", # Optional. Streaming error.
+    },
+    "webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync.
+  },
+  "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+  "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
+    "A String",
+  ],
+  "state": "A String", # Output only. State of the connector.
+  "staticIpAddresses": [ # Output only. The static IP addresses used by this connector.
+    "A String",
+  ],
+  "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector.
+  "syncMode": "A String", # The data synchronization mode supported by the data connector.
+  "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated.
+}
+
+  collectionDisplayName: string, Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
+  collectionId: string, Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
 

     updateAclConfig(name, body=None, x__xgafv=None)
   
Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.html b/docs/dyn/discoveryengine_v1alpha.projects.html
index 927de72a02a..2e4f8a91e00 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.html
@@ -90,6 +90,9 @@ 
Instance Methods

 

   get(name, x__xgafv=None)

 
Gets a Project. Returns NOT_FOUND when the project is not yet created.

+

+  patch(name, body=None, updateMask=None, x__xgafv=None)

+
Updates the editable settings of a Discovery Engine Project.

 

   provision(name, body=None, x__xgafv=None)

 
Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.

@@ -118,6 +121,79 @@ 
Method Details

 
     { # Metadata and configurations for a Google Cloud project in the service.
   "createTime": "A String", # Output only. The timestamp when this project is created.
+  "customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
+    "notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
+      "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
+        "responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
+        "userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
+      },
+    },
+  },
+  "name": "A String", # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
+  "provisionCompletionTime": "A String", # Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
+  "serviceTermsMap": { # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
+    "a_key": { # Metadata about the terms of service.
+      "acceptTime": "A String", # The last time when the project agreed to the terms of service.
+      "declineTime": "A String", # The last time when the project declined or revoked the agreement to terms of service.
+      "id": "A String", # The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.
+      "state": "A String", # Whether the project has accepted/rejected the service terms or it is still pending.
+      "version": "A String", # The version string of the terms of service. For acceptable values, see the comments for id above.
+    },
+  },
+}

+

+
+

+    patch(name, body=None, updateMask=None, x__xgafv=None)
+  
Updates the editable settings of a Discovery Engine Project.
+
+Args:
+  name: string, Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Metadata and configurations for a Google Cloud project in the service.
+  "createTime": "A String", # Output only. The timestamp when this project is created.
+  "customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
+    "notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
+      "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
+        "responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
+        "userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
+      },
+    },
+  },
+  "name": "A String", # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
+  "provisionCompletionTime": "A String", # Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
+  "serviceTermsMap": { # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
+    "a_key": { # Metadata about the terms of service.
+      "acceptTime": "A String", # The last time when the project agreed to the terms of service.
+      "declineTime": "A String", # The last time when the project declined or revoked the agreement to terms of service.
+      "id": "A String", # The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.
+      "state": "A String", # Whether the project has accepted/rejected the service terms or it is still pending.
+      "version": "A String", # The version string of the terms of service. For acceptable values, see the comments for id above.
+    },
+  },
+}
+
+  updateMask: string, Optional. The list of fields to update. Supported fields: * `customer_provided_config`
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Metadata and configurations for a Google Cloud project in the service.
+  "createTime": "A String", # Output only. The timestamp when this project is created.
+  "customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
+    "notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
+      "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
+        "responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
+        "userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
+      },
+    },
+  },
   "name": "A String", # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
   "provisionCompletionTime": "A String", # Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
   "serviceTermsMap": { # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
@@ -146,6 +222,7 @@ 
Method Details

   "dataUseTermsVersion": "A String", # Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.
   "saasParams": { # Parameters for Agentspace. # Optional. Parameters for Agentspace.
     "acceptBizQos": True or False, # Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].
+    "isBiz": True or False, # Optional. Indicates if the current request is for Biz edition (= true) or not (= false).
   },
 }
 
@@ -203,6 +280,14 @@ 
Method Details

 
     { # Metadata and configurations for a Google Cloud project in the service.
   "createTime": "A String", # Output only. The timestamp when this project is created.
+  "customerProvidedConfig": { # Customer provided configurations. # Optional. Customer provided configurations.
+    "notebooklmConfig": { # Configuration for NotebookLM. # Optional. Configuration for NotebookLM settings.
+      "modelArmorConfig": { # Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses. # Model Armor configuration to be used for sanitizing user prompts and LLM responses.
+        "responseTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.
+        "userPromptTemplate": "A String", # Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.
+      },
+    },
+  },
   "name": "A String", # Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
   "provisionCompletionTime": "A String", # Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.
   "serviceTermsMap": { # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
index 3ff8d6e13ae..99993ae8377 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html
@@ -239,6 +239,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
@@ -1503,13 +1506,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -1533,6 +1539,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2120,13 +2131,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -2150,6 +2164,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2745,6 +2764,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html
index 33ebb3ab7e6..e64d328ac19 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html
@@ -285,12 +285,13 @@ 
Method Details

     "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
     "disableUserEventsCollection": True or False, # If set to true, the widget will not collect user events.
     "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+    "enableCreateAgentButton": True or False, # Optional. If set to true, the widget will enable the create agent button.
     "enablePeopleSearch": True or False, # Optional. If set to true, the widget will enable people search.
     "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
     "enableSafeSearch": True or False, # Whether to enable safe search.
     "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget.
     "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
-    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
       "a_key": "A String",
     },
     "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
index f8933a37609..56bd84bdf0f 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.assistants.html
@@ -360,6 +360,7 @@ 
Method Details

                 "documentMetadata": { # Document metadata. # Document metadata.
                   "document": "A String", # Document resource name.
                   "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.
+                  "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.
                   "pageIdentifier": "A String", # Page identifier.
                   "title": "A String", # Title.
                   "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
index 4c0ecce8181..14edf1b019f 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
@@ -182,13 +182,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -326,13 +327,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -411,13 +413,14 @@ 
Method Details

       "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
         "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
       },
+      "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
       "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
       "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
         "A String",
       ],
       "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
       "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-      "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+      "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
         "a_key": "A String",
       },
       "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -503,13 +506,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -577,13 +581,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -663,13 +668,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -749,13 +755,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
index 462c7074b68..4587f407160 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html
@@ -239,6 +239,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
@@ -1503,13 +1506,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -1533,6 +1539,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2120,13 +2131,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -2150,6 +2164,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2745,6 +2764,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html
index 2d4effb6b2d..778307cf53e 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html
@@ -285,12 +285,13 @@ 
Method Details

     "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
     "disableUserEventsCollection": True or False, # If set to true, the widget will not collect user events.
     "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+    "enableCreateAgentButton": True or False, # Optional. If set to true, the widget will enable the create agent button.
     "enablePeopleSearch": True or False, # Optional. If set to true, the widget will enable people search.
     "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
     "enableSafeSearch": True or False, # Whether to enable safe search.
     "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget.
     "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
-    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
       "a_key": "A String",
     },
     "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
index 2e0ab101208..332b5ae6aba 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
@@ -221,8 +221,9 @@ 
Method Details

             "port": 42, # Optional. Target port number accepted by the destination.
           },
         ],
+        "jsonParams": "A String", # Additional parameters for this destination config in json string format.
         "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
-        "params": { # Optional. Additional parameters for this destination config.
+        "params": { # Optional. Additional parameters for this destination config in structured json format.
           "a_key": "", # Properties of the object.
         },
       },
@@ -248,10 +249,11 @@ 
Method Details

           "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
           "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
         },
+        "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
         "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
           "a_key": "A String",
         },
-        "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.
+        "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
           "a_key": "", # Properties of the object.
         },
         "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
@@ -323,6 +325,7 @@ 
Method Details

     },
     "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
     "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+    "jsonParams": "A String", # Required data connector parameters in json string format.
     "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
     "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
     "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
@@ -341,7 +344,7 @@ 
Method Details

       "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
       "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
     },
-    "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.
+    "params": { # Required data connector parameters in structured json format.
       "a_key": "", # Properties of the object.
     },
     "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
@@ -439,8 +442,9 @@ 
Method Details

           "port": 42, # Optional. Target port number accepted by the destination.
         },
       ],
+      "jsonParams": "A String", # Additional parameters for this destination config in json string format.
       "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
-      "params": { # Optional. Additional parameters for this destination config.
+      "params": { # Optional. Additional parameters for this destination config in structured json format.
         "a_key": "", # Properties of the object.
       },
     },
@@ -466,10 +470,11 @@ 
Method Details

         "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
         "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
       },
+      "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
       "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
         "a_key": "A String",
       },
-      "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.
+      "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
         "a_key": "", # Properties of the object.
       },
       "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
@@ -541,6 +546,7 @@ 
Method Details

   },
   "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
   "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+  "jsonParams": "A String", # Required data connector parameters in json string format.
   "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
   "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
   "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
@@ -559,7 +565,7 @@ 
Method Details

     "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
     "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
   },
-  "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.
+  "params": { # Required data connector parameters in structured json format.
     "a_key": "", # Properties of the object.
   },
   "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
@@ -661,8 +667,9 @@ 
Method Details

                 "port": 42, # Optional. Target port number accepted by the destination.
               },
             ],
+            "jsonParams": "A String", # Additional parameters for this destination config in json string format.
             "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
-            "params": { # Optional. Additional parameters for this destination config.
+            "params": { # Optional. Additional parameters for this destination config in structured json format.
               "a_key": "", # Properties of the object.
             },
           },
@@ -688,10 +695,11 @@ 
Method Details

               "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
               "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
             },
+            "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
             "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
               "a_key": "A String",
             },
-            "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.
+            "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
               "a_key": "", # Properties of the object.
             },
             "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
@@ -763,6 +771,7 @@ 
Method Details

         },
         "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
         "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+        "jsonParams": "A String", # Required data connector parameters in json string format.
         "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
         "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
         "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
@@ -781,7 +790,7 @@ 
Method Details

           "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
           "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
         },
-        "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.
+        "params": { # Required data connector parameters in structured json format.
           "a_key": "", # Properties of the object.
         },
         "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
@@ -893,8 +902,9 @@ 
Method Details

             "port": 42, # Optional. Target port number accepted by the destination.
           },
         ],
+        "jsonParams": "A String", # Additional parameters for this destination config in json string format.
         "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
-        "params": { # Optional. Additional parameters for this destination config.
+        "params": { # Optional. Additional parameters for this destination config in structured json format.
           "a_key": "", # Properties of the object.
         },
       },
@@ -920,10 +930,11 @@ 
Method Details

           "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
           "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
         },
+        "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
         "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
           "a_key": "A String",
         },
-        "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.
+        "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
           "a_key": "", # Properties of the object.
         },
         "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
@@ -995,6 +1006,7 @@ 
Method Details

     },
     "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
     "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+    "jsonParams": "A String", # Required data connector parameters in json string format.
     "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
     "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
     "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
@@ -1013,7 +1025,7 @@ 
Method Details

       "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
       "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
     },
-    "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.
+    "params": { # Required data connector parameters in structured json format.
       "a_key": "", # Properties of the object.
     },
     "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
@@ -1135,8 +1147,9 @@ 
Method Details

           "port": 42, # Optional. Target port number accepted by the destination.
         },
       ],
+      "jsonParams": "A String", # Additional parameters for this destination config in json string format.
       "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
-      "params": { # Optional. Additional parameters for this destination config.
+      "params": { # Optional. Additional parameters for this destination config in structured json format.
         "a_key": "", # Properties of the object.
       },
     },
@@ -1162,10 +1175,11 @@ 
Method Details

         "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
         "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
       },
+      "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
       "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
         "a_key": "A String",
       },
-      "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.
+      "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
         "a_key": "", # Properties of the object.
       },
       "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
@@ -1237,6 +1251,7 @@ 
Method Details

   },
   "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
   "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+  "jsonParams": "A String", # Required data connector parameters in json string format.
   "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
   "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
   "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
@@ -1255,7 +1270,7 @@ 
Method Details

     "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
     "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
   },
-  "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.
+  "params": { # Required data connector parameters in structured json format.
     "a_key": "", # Properties of the object.
   },
   "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
@@ -1344,8 +1359,9 @@ 
Method Details

           "port": 42, # Optional. Target port number accepted by the destination.
         },
       ],
+      "jsonParams": "A String", # Additional parameters for this destination config in json string format.
       "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
-      "params": { # Optional. Additional parameters for this destination config.
+      "params": { # Optional. Additional parameters for this destination config in structured json format.
         "a_key": "", # Properties of the object.
       },
     },
@@ -1371,10 +1387,11 @@ 
Method Details

         "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
         "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
       },
+      "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
       "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
         "a_key": "A String",
       },
-      "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.
+      "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
         "a_key": "", # Properties of the object.
       },
       "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
@@ -1446,6 +1463,7 @@ 
Method Details

   },
   "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
   "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+  "jsonParams": "A String", # Required data connector parameters in json string format.
   "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
   "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
   "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
@@ -1464,7 +1482,7 @@ 
Method Details

     "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
     "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
   },
-  "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.
+  "params": { # Required data connector parameters in structured json format.
     "a_key": "", # Properties of the object.
   },
   "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
index 9fb7d23d5c7..3982ea80793 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html
@@ -239,6 +239,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
@@ -1503,13 +1506,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -1533,6 +1539,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2120,13 +2131,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -2150,6 +2164,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2745,6 +2764,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html
index 4617fc25c53..a03ecefce27 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html
@@ -285,12 +285,13 @@ 
Method Details

     "defaultSearchRequestOrderBy": "A String", # The default ordering for search results if specified. Used to set SearchRequest#order_by on applicable requests. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
     "disableUserEventsCollection": True or False, # If set to true, the widget will not collect user events.
     "enableAutocomplete": True or False, # Whether or not to enable autocomplete.
+    "enableCreateAgentButton": True or False, # Optional. If set to true, the widget will enable the create agent button.
     "enablePeopleSearch": True or False, # Optional. If set to true, the widget will enable people search.
     "enableQualityFeedback": True or False, # Turn on or off collecting the search result quality feedback from end users.
     "enableSafeSearch": True or False, # Whether to enable safe search.
     "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget.
     "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search.
-    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+    "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
       "a_key": "A String",
     },
     "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html
index d509a8edf5e..67389f2271f 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html
@@ -281,13 +281,16 @@ 
Method Details

       },
       "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
           "A String",
         ],
       },
-      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
       "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
       "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
       "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -311,6 +314,11 @@ 
Method Details

       },
       "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
       "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+        "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+        "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+        "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+      },
       "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
         "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
       },
@@ -580,13 +588,16 @@ 
Method Details

       },
       "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
           "A String",
         ],
       },
-      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
       "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
       "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
       "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -610,6 +621,11 @@ 
Method Details

       },
       "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
       "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+        "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+        "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+        "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+      },
       "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
         "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
       },
@@ -855,13 +871,16 @@ 
Method Details

           },
           "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
           "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+            "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+              "A String",
+            ],
             "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
             "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
             "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
               "A String",
             ],
           },
-          "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
           "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
           "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
           "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -885,6 +904,11 @@ 
Method Details

           },
           "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
           "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+          "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+            "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+            "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+            "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+          },
           "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
             "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
           },
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html
index c032825d8c0..5276bf5998f 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html
@@ -168,6 +168,9 @@ 
Instance Methods

 

   setUpDataConnector(parent, body=None, x__xgafv=None)

 
Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.

+

+  setUpDataConnectorV2(parent, body=None, collectionDisplayName=None, collectionId=None, x__xgafv=None)

+
Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.

 

   updateAclConfig(name, body=None, x__xgafv=None)

 
Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.

@@ -981,8 +984,9 @@ 
Method Details

             "port": 42, # Optional. Target port number accepted by the destination.
           },
         ],
+        "jsonParams": "A String", # Additional parameters for this destination config in json string format.
         "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
-        "params": { # Optional. Additional parameters for this destination config.
+        "params": { # Optional. Additional parameters for this destination config in structured json format.
           "a_key": "", # Properties of the object.
         },
       },
@@ -1008,10 +1012,11 @@ 
Method Details

           "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
           "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
         },
+        "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
         "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
           "a_key": "A String",
         },
-        "params": { # The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.
+        "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
           "a_key": "", # Properties of the object.
         },
         "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
@@ -1083,6 +1088,7 @@ 
Method Details

     },
     "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
     "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+    "jsonParams": "A String", # Required data connector parameters in json string format.
     "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
     "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
     "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
@@ -1101,7 +1107,7 @@ 
Method Details

       "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
       "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
     },
-    "params": { # Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { "instance_uri": "https://xxx.atlassian.net", "user_account": "xxxx.xxx@xxx.com", "api_token": "test-token" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.
+    "params": { # Required data connector parameters in structured json format.
       "a_key": "", # Properties of the object.
     },
     "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
@@ -1165,6 +1171,249 @@ 
Method Details

 }

 

 
+

+    setUpDataConnectorV2(parent, body=None, collectionDisplayName=None, collectionId=None, x__xgafv=None)
+  
Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.
+
+Args:
+  parent: string, Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.
+  "aclEnabled": True or False, # Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.
+  "actionConfig": { # Informations to support actions on the connector. # Optional. Action configurations to make the connector support actions.
+    "actionParams": { # Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.
+      "a_key": "", # Properties of the object.
+    },
+    "isActionConfigured": True or False, # Output only. The connector contains the necessary parameters and is configured to support actions.
+    "serviceName": "A String", # Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
+    "useStaticSecrets": True or False, # Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.
+  },
+  "actionState": "A String", # Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.
+  "alertPolicyConfigs": [ # Optional. The connector level alert config.
+    { # The connector level alert config.
+      "alertEnrollments": [ # Optional. The enrollment states of each alert.
+        { # The alert enrollment status.
+          "alertId": "A String", # Immutable. The id of an alert.
+          "enrollState": "A String", # Required. The enrollment status of a customer.
+        },
+      ],
+      "alertPolicyName": "A String", # Immutable. The fully qualified resource name of the AlertPolicy.
+    },
+  ],
+  "autoRunDisabled": True or False, # Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs
+  "bapConfig": { # The configuration for the BAP connector. # Optional. The configuration for establishing a BAP connection.
+    "supportedConnectorModes": [ # Required. The supported connector modes for the associated BAP connection.
+      "A String",
+    ],
+  },
+  "blockingReasons": [ # Output only. User actions that must be completed before the connector can start syncing data.
+    "A String",
+  ],
+  "connectorModes": [ # Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.
+    "A String",
+  ],
+  "connectorType": "A String", # Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.
+  "createEuaSaas": True or False, # Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.
+  "createTime": "A String", # Output only. Timestamp the DataConnector was created at.
+  "dataSource": "A String", # Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.
+  "destinationConfigs": [ # Optional. Any target destinations used to connect to third-party services.
+    { # Defines target endpoints used to connect to third-party sources.
+      "destinations": [ # Optional. The destinations for the corresponding key.
+        { # Defines a target endpoint
+          "host": "A String", # Publicly routable host.
+          "port": 42, # Optional. Target port number accepted by the destination.
+        },
+      ],
+      "jsonParams": "A String", # Additional parameters for this destination config in json string format.
+      "key": "A String", # Optional. Unique destination identifier that is supported by the connector.
+      "params": { # Optional. Additional parameters for this destination config in structured json format.
+        "a_key": "", # Properties of the object.
+      },
+    },
+  ],
+  "endUserConfig": { # Any params and credentials used specifically for EUA connectors. # Optional. Any params and credentials used specifically for EUA connectors.
+    "additionalParams": { # Optional. Any additional parameters needed for EUA.
+      "a_key": "", # Properties of the object.
+    },
+    "authParams": { # Optional. Any authentication parameters specific to EUA connectors.
+      "a_key": "", # Properties of the object.
+    },
+    "tenant": { # Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user. # Optional. The tenant project the connector is connected to.
+      "displayName": "A String", # Optional display name for the tenant, e.g. "My Slack Team".
+      "id": "A String", # The tenant's instance ID. Examples: Jira ("8594f221-9797-5f78-1fa4-485e198d7cd0"), Slack ("T123456").
+      "uri": "A String", # The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.
+    },
+  },
+  "entities": [ # List of entities from the connected data source to ingest.
+    { # Represents an entity in the data source. For example, the `Account` object in Salesforce.
+      "dataStore": "A String", # Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.
+      "entityName": "A String", # The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`
+      "healthcareFhirConfig": { # Config to data store for `HEALTHCARE_FHIR` vertical. # Optional. Configuration for `HEALTHCARE_FHIR` vertical.
+        "enableConfigurableSchema": True or False, # Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering.
+        "enableStaticIndexingForBatchIngestion": True or False, # Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
+      },
+      "jsonParams": "A String", # The parameters for the entity to facilitate data ingestion in json string format.
+      "keyPropertyMappings": { # Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.
+        "a_key": "A String",
+      },
+      "params": { # The parameters for the entity to facilitate data ingestion in structured json format.
+        "a_key": "", # Properties of the object.
+      },
+      "startingSchema": { # Defines the structure and layout of a type of document data. # Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
+        "fieldConfigs": [ # Output only. Configurations for fields of the schema.
+          { # Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
+            "advancedSiteSearchDataSources": [ # If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.
+              "A String",
+            ],
+            "completableOption": "A String", # If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.
+            "dynamicFacetableOption": "A String", # If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.
+            "fieldPath": "A String", # Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.
+            "fieldType": "A String", # Output only. Raw type of the field.
+            "indexableOption": "A String", # If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.
+            "keyPropertyType": "A String", # Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.
+            "metatagName": "A String", # Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.
+            "recsFilterableOption": "A String", # If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.
+            "retrievableOption": "A String", # If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.
+            "schemaOrgPaths": [ # Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished
+              "A String",
+            ],
+            "searchableOption": "A String", # If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.
+          },
+        ],
+        "jsonSchema": "A String", # The JSON representation of the schema.
+        "name": "A String", # Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "structSchema": { # The structured representation of the schema.
+          "a_key": "", # Properties of the object.
+        },
+      },
+    },
+  ],
+  "errors": [ # Output only. The errors from initialization or from the latest connector run.
+    { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+        {
+          "a_key": "", # Properties of the object. Contains field @type with type URL.
+        },
+      ],
+      "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+    },
+  ],
+  "federatedConfig": { # Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. # Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode.
+    "additionalParams": { # Optional. Any additional parameters needed for FEDERATED.
+      "a_key": "", # Properties of the object.
+    },
+    "authParams": { # Optional. Any authentication parameters specific to FEDERATED.
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "hybridIngestionDisabled": True or False, # Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.
+  "identityRefreshInterval": "A String", # The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+  "identityScheduleConfig": { # The configuration for the identity data synchronization runs. # The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector.
+    "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day.
+      "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+      "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+      "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+      "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+      "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+      "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+        "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+      },
+      "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+      "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+    },
+    "refreshInterval": "A String", # Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.
+  },
+  "incrementalRefreshInterval": "A String", # Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+  "incrementalSyncDisabled": True or False, # Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.
+  "jsonParams": "A String", # Required data connector parameters in json string format.
+  "kmsKeyName": "A String", # Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.
+  "lastSyncTime": "A String", # Output only. For periodic connectors only, the last time a data sync was completed.
+  "latestPauseTime": "A String", # Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.
+  "name": "A String", # Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.
+  "nextSyncTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity.
+    "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
+    "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+    "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
+    "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
+    "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
+    "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
+    "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
+  },
+  "params": { # Required data connector parameters in structured json format.
+    "a_key": "", # Properties of the object.
+  },
+  "privateConnectivityProjectId": "A String", # Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.
+  "realtimeState": "A String", # Output only. real-time sync state
+  "realtimeSyncConfig": { # The configuration for realtime sync to store additional params for realtime sync. # Optional. The configuration for realtime sync.
+    "realtimeSyncSecret": "A String", # Optional. The ID of the Secret Manager secret used for webhook secret.
+    "streamingError": { # Streaming error details. # Optional. Streaming error details.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Optional. Error details.
+        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+          {
+            "a_key": "", # Properties of the object. Contains field @type with type URL.
+          },
+        ],
+        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+      },
+      "streamingErrorReason": "A String", # Optional. Streaming error.
+    },
+    "webhookUri": "A String", # Optional. Webhook url for the connector to specify additional params for realtime sync.
+  },
+  "refreshInterval": "A String", # Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.
+  "removeParamKeys": [ # Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.
+    "A String",
+  ],
+  "state": "A String", # Output only. State of the connector.
+  "staticIpAddresses": [ # Output only. The static IP addresses used by this connector.
+    "A String",
+  ],
+  "staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector.
+  "syncMode": "A String", # The data synchronization mode supported by the data connector.
+  "updateTime": "A String", # Output only. Timestamp the DataConnector was last updated.
+}
+
+  collectionDisplayName: string, Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
+  collectionId: string, Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
 

     updateAclConfig(name, body=None, x__xgafv=None)
   
Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html
index b473a699d39..5f088b4c688 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.audioOverviews.html
@@ -120,12 +120,19 @@ 
Method Details

 
     { # Response for AudioOverviewService.CreateAudioOverview method.
   "audioOverview": { # An audio overview of a notebook. This is a summary of the notebook in audio format. # The generated audio overview.
-    "audio": "A String", # The audio overview in wav format. This is only present if the status is AUDIO_OVERVIEW_STATUS_COMPLETE.
     "audioOverviewId": "A String", # Output only. Unique ID of the audio overview.
+    "generationOptions": { # Options used during audio overview generation. # The options used to generate the audio overview.
+      "episodeFocus": "A String", # What the hosts of the show should focus on.
+      "languageCode": "A String", # The language that the audio overview was requested in.
+      "sourceIds": [ # Optional. The sources in which the audio overview is grounded.
+        { # SourceId is the last segment of the source's resource name.
+          "id": "A String", # The id of the source.
+        },
+      ],
+    },
     "languageCode": "A String", # The language code of the generated audio overview. Use the BCP 47 language code (e.g. "en", "es", "hi", etc.).
     "mimeType": "A String", # The mime type of the audio overview.
     "name": "A String", # Identifier. The full resource name of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
-    "playbackUrl": "A String", # The url used to play the audio overview.
     "status": "A String", # The status of the audio overview.
   },
 }

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html
index fccded39f56..17732cc22c9 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.notebooks.sources.html
@@ -559,6 +559,7 @@ 
Method Details

     "diffObjectVersion": "A String", # Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.
     "finalStatus": 42, # The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929
     "notificationType": "A String", # The type of notification received from Scotty.
+    "physicalHeaders": "A String", # The physical headers provided by RequestReceivedParameters in Scotty request. type is uploader_service.KeyValuePairs.
     "requestId": "A String", # The Scotty request ID.
     "requestReceivedParamsServingInfo": "A String", # The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()
     "totalBytes": "A String", # The total size of the file.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.html b/docs/dyn/discoveryengine_v1beta.projects.html
index 88084cbaa9e..18389299835 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.html
@@ -110,6 +110,7 @@ 
Method Details

   "dataUseTermsVersion": "A String", # Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.
   "saasParams": { # Parameters for Agentspace. # Optional. Parameters for Agentspace.
     "acceptBizQos": True or False, # Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].
+    "isBiz": True or False, # Optional. Indicates if the current request is for Biz edition (= true) or not (= false).
   },
 }
 
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html
index d2f8ce44b9d..9ae5a1b2577 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html
@@ -236,6 +236,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
@@ -1465,13 +1468,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -1495,6 +1501,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2078,13 +2089,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -2108,6 +2122,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2699,6 +2718,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html
index ad74e79202e..0cd1b31f292 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.assistants.html
@@ -360,6 +360,7 @@ 
Method Details

                 "documentMetadata": { # Document metadata. # Document metadata.
                   "document": "A String", # Document resource name.
                   "domain": "A String", # Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.
+                  "mimeType": "A String", # The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.
                   "pageIdentifier": "A String", # Page identifier.
                   "title": "A String", # Title.
                   "uri": "A String", # URI for the document. It may contain a URL that redirects to the actual website.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
index 26f13da7ed2..2b66e8f53ea 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
@@ -172,13 +172,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -307,13 +308,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -383,13 +385,14 @@ 
Method Details

       "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
         "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
       },
+      "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
       "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
       "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
         "A String",
       ],
       "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
       "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-      "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+      "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
         "a_key": "A String",
       },
       "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -466,13 +469,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -531,13 +535,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -608,13 +613,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
@@ -685,13 +691,14 @@ 
Method Details

   "commonConfig": { # Common configurations for an Engine. # Common config spec that specifies the metadata of the engine.
     "companyName": "A String", # The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
   },
+  "configurableBillingApproach": "A String", # Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.
   "createTime": "A String", # Output only. Timestamp the Recommendation Engine was created at.
   "dataStoreIds": [ # Optional. The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.
     "A String",
   ],
   "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine.
   "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
-  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.
+  "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`
     "a_key": "A String",
   },
   "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html
index fe07bcf8b2d..77b37d25fef 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html
@@ -236,6 +236,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
@@ -1465,13 +1468,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -1495,6 +1501,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2078,13 +2089,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -2108,6 +2122,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2699,6 +2718,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html
index fb1aa1dd731..71c5b894380 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html
@@ -236,6 +236,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
@@ -1465,13 +1468,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -1495,6 +1501,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2078,13 +2089,16 @@ 
Method Details

   },
   "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
   "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+    "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+      "A String",
+    ],
     "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
     "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
     "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
       "A String",
     ],
   },
-  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+  "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
   "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
   "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -2108,6 +2122,11 @@ 
Method Details

   },
   "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
   "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+  "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+    "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+    "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+    "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+  },
   "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
     "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
   },
@@ -2699,6 +2718,9 @@ 
Method Details

       "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
       "maxReturnResults": 42, # Number of search results to return. The default value is 10.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Optional. Specification to enable natural language understanding capabilities for search requests.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html
index 40afb1399f2..95571f8e2af 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html
@@ -278,13 +278,16 @@ 
Method Details

       },
       "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
           "A String",
         ],
       },
-      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
       "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
       "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
       "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -308,6 +311,11 @@ 
Method Details

       },
       "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
       "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+        "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+        "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+        "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+      },
       "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
         "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
       },
@@ -573,13 +581,16 @@ 
Method Details

       },
       "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
       "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+          "A String",
+        ],
         "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
         "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
         "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
           "A String",
         ],
       },
-      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
       "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
       "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
       "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -603,6 +614,11 @@ 
Method Details

       },
       "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
       "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+      "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+        "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+        "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+        "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+      },
       "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
         "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
       },
@@ -844,13 +860,16 @@ 
Method Details

           },
           "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
           "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+            "allowedFieldNames": [ # Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.
+              "A String",
+            ],
             "extractedFilterBehavior": "A String", # Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
             "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.
             "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
               "A String",
             ],
           },
-          "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.
           "oneBoxPageSize": 42, # The maximum number of results to return for OneBox. This applies to each OneBox type individually. Default number is 10.
           "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
           "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
@@ -874,6 +893,11 @@ 
Method Details

           },
           "relevanceThreshold": "A String", # The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
           "safeSearch": True or False, # Whether to turn on safe search. This is only supported for website search.
+          "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests.
+            "disableGenerativeAnswerAddOn": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.
+            "disableKpiPersonalizationAddOn": True or False, # Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.
+            "disableSemanticAddOn": True or False, # Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.
+          },
           "searchAsYouTypeSpec": { # Specification for search as you type in search requests. # Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical.
             "condition": "A String", # The condition under which search as you type should occur. Default to Condition.DISABLED.
           },
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
index 6b43af3b92e..ddf793fd360 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json
@@ -260,6 +260,72 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"setUpDataConnector": {
+"description": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setUpDataConnector",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.setUpDataConnector",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}:setUpDataConnector",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"setUpDataConnectorV2": {
+"description": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}:setUpDataConnectorV2",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.setUpDataConnectorV2",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"collectionDisplayName": {
+"description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.",
+"location": "query",
+"type": "string"
+},
+"collectionId": {
+"description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}:setUpDataConnectorV2",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnector"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "updateAclConfig": {
 "description": "Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aclConfig",
@@ -436,6 +502,92 @@
 }
 },
 "collections": {
+"methods": {
+"delete": {
+"description": "Deletes a Collection.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}",
+"httpMethod": "DELETE",
+"id": "discoveryengine.projects.locations.collections.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The full resource name of the Collection, in the format of `projects/{project}/locations/{location}/collections/{collection}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"getDataConnector": {
+"description": "Gets the DataConnector. DataConnector is a singleton resource for each Collection.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.collections.getDataConnector",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Full resource name of DataConnector, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`. If the caller does not have permission to access the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataConnector does not exist, a NOT_FOUND error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnector"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"updateDataConnector": {
+"description": "Updates a DataConnector.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataConnector",
+"httpMethod": "PATCH",
+"id": "discoveryengine.projects.locations.collections.updateDataConnector",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataConnector$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnector"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnector"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
 "resources": {
 "dataConnector": {
 "resources": {
@@ -7344,7 +7496,7 @@
 }
 }
 },
-"revision": "20250908",
+"revision": "20250918",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GdataBlobstore2Info": {
@@ -8205,6 +8357,34 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1ActionConfig": {
+"description": "Informations to support actions on the connector.",
+"id": "GoogleCloudDiscoveryengineV1ActionConfig",
+"properties": {
+"actionParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
+"type": "object"
+},
+"isActionConfigured": {
+"description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
+"readOnly": true,
+"type": "boolean"
+},
+"serviceName": {
+"description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.",
+"type": "string"
+},
+"useStaticSecrets": {
+"description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest": {
 "description": "Request message for CompletionService.AdvancedCompleteQuery method. .",
 "id": "GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequest",
@@ -8532,6 +8712,49 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1AlertPolicyConfig": {
+"description": "The connector level alert config.",
+"id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig",
+"properties": {
+"alertEnrollments": {
+"description": "Optional. The enrollment states of each alert.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment"
+},
+"type": "array"
+},
+"alertPolicyName": {
+"description": "Immutable. The fully qualified resource name of the AlertPolicy.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment": {
+"description": "The alert enrollment status.",
+"id": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment",
+"properties": {
+"alertId": {
+"description": "Immutable. The id of an alert.",
+"type": "string"
+},
+"enrollState": {
+"description": "Required. The enrollment status of a customer.",
+"enum": [
+"ENROLL_STATES_UNSPECIFIED",
+"ENROLLED",
+"DECLINED"
+],
+"enumDescriptions": [
+"Default value. Used for customers who have not responded to the alert policy.",
+"Customer is enrolled in this policy.",
+"Customer declined this policy."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1AlloyDbSource": {
 "description": "AlloyDB source import data from.",
 "id": "GoogleCloudDiscoveryengineV1AlloyDbSource",
@@ -10227,6 +10450,10 @@
 "description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.",
 "type": "string"
 },
+"mimeType": {
+"description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.",
+"type": "string"
+},
 "pageIdentifier": {
 "description": "Page identifier.",
 "type": "string"
@@ -10305,6 +10532,32 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1BAPConfig": {
+"description": "The configuration for the BAP connector.",
+"id": "GoogleCloudDiscoveryengineV1BAPConfig",
+"properties": {
+"supportedConnectorModes": {
+"description": "Required. The supported connector modes for the associated BAP connection.",
+"items": {
+"enum": [
+"CONNECTOR_MODE_UNSPECIFIED",
+"DATA_INGESTION",
+"ACTIONS",
+"END_USER_AUTHENTICATION"
+],
+"enumDescriptions": [
+"Connector mode unspecified.",
+"Connector utilized for data ingestion.",
+"Connector utilized for Actions",
+"Connector utilized for End User Authentication."
+],
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata",
@@ -11107,6 +11360,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1Collection": {
+"description": "Collection is a container for configuring resources and access to a set of DataStores.",
+"id": "GoogleCloudDiscoveryengineV1Collection",
+"properties": {
+"createTime": {
+"description": "Output only. Timestamp the Collection was created at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"displayName": {
+"description": "Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
+"type": "string"
+},
+"name": {
+"description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1CompleteQueryResponse": {
 "description": "Response message for CompletionService.CompleteQuery method.",
 "id": "GoogleCloudDiscoveryengineV1CompleteQueryResponse",
@@ -11810,19 +12084,496 @@
 ],
 "type": "string"
 },
-"modelVersion": {
-"description": "The version of the model.",
-"format": "int64",
+"modelVersion": {
+"description": "The version of the model.",
+"format": "int64",
+"type": "string"
+},
+"name": {
+"description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.",
+"type": "string"
+},
+"trainingStartTime": {
+"description": "Timestamp the model training was initiated.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnector": {
+"description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.",
+"id": "GoogleCloudDiscoveryengineV1DataConnector",
+"properties": {
+"aclEnabled": {
+"description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.",
+"type": "boolean"
+},
+"actionConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ActionConfig",
+"description": "Optional. Action configurations to make the connector support actions."
+},
+"actionState": {
+"description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"FAILED",
+"RUNNING",
+"WARNING",
+"INITIALIZATION_FAILED",
+"UPDATING"
+],
+"enumDescriptions": [
+"Default value.",
+"The connector is being set up.",
+"The connector is successfully set up and awaiting next sync run.",
+"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
+"The connector is actively syncing records from the data source.",
+"The connector has completed a sync run, but encountered non-fatal errors.",
+"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
+"Connector is in the process of an update."
+],
+"readOnly": true,
+"type": "string"
+},
+"alertPolicyConfigs": {
+"description": "Optional. The connector level alert config.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfig"
+},
+"type": "array"
+},
+"autoRunDisabled": {
+"description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs",
+"type": "boolean"
+},
+"bapConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1BAPConfig",
+"description": "Optional. The configuration for establishing a BAP connection."
+},
+"blockingReasons": {
+"description": "Output only. User actions that must be completed before the connector can start syncing data.",
+"items": {
+"enum": [
+"BLOCKING_REASON_UNSPECIFIED",
+"ALLOWLIST_STATIC_IP",
+"ALLOWLIST_IN_SERVICE_ATTACHMENT",
+"ALLOWLIST_SERVICE_ACCOUNT"
+],
+"enumDescriptions": [
+"Default value.",
+"Connector requires customer to allowlist static IPs.",
+"Connector requires customer to allowlist our project in their service attachment.",
+"Connector requires customer to allowlist service account in their project."
+],
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"connectorModes": {
+"description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
+"items": {
+"enum": [
+"CONNECTOR_MODE_UNSPECIFIED",
+"DATA_INGESTION",
+"ACTIONS",
+"FEDERATED",
+"EUA",
+"FEDERATED_AND_EUA"
+],
+"enumDescriptions": [
+"Connector mode unspecified.",
+"Connector utilized for data ingestion.",
+"Connector utilized for actions.",
+"Connector utilized for federated search.",
+"Connector utilized for End User Authentication.",
+"Hybrid connector utilized for federated search and End User Authentication."
+],
+"type": "string"
+},
+"type": "array"
+},
+"connectorType": {
+"description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.",
+"enum": [
+"CONNECTOR_TYPE_UNSPECIFIED",
+"THIRD_PARTY",
+"GCP_FHIR",
+"BIG_QUERY",
+"GCS",
+"GOOGLE_MAIL",
+"GOOGLE_CALENDAR",
+"GOOGLE_DRIVE",
+"NATIVE_CLOUD_IDENTITY",
+"THIRD_PARTY_FEDERATED",
+"THIRD_PARTY_EUA",
+"GCNV"
+],
+"enumDescriptions": [
+"Default value.",
+"Third party connector to connector to third party application.",
+"Data connector connects between FHIR store and VAIS datastore.",
+"Big query connector.",
+"Google Cloud Storage connector.",
+"Gmail connector.",
+"Google Calendar connector.",
+"Google Drive connector.",
+"Native Cloud Identity connector for people search powered by People API.",
+"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
+"Connector utilized for End User Authentication features.",
+"Google Cloud NetApp Volumes connector."
+],
+"readOnly": true,
+"type": "string"
+},
+"createEuaSaas": {
+"description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.",
+"type": "boolean"
+},
+"createTime": {
+"description": "Output only. Timestamp the DataConnector was created at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"dataSource": {
+"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.",
+"type": "string"
+},
+"destinationConfigs": {
+"description": "Optional. Any target destinations used to connect to third-party services.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1DestinationConfig"
+},
+"type": "array"
+},
+"endUserConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig",
+"description": "Optional. Any params and credentials used specifically for EUA connectors."
+},
+"entities": {
+"description": "List of entities from the connected data source to ingest.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity"
+},
+"type": "array"
+},
+"errors": {
+"description": "Output only. The errors from initialization or from the latest connector run.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"readOnly": true,
+"type": "array"
+},
+"federatedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig",
+"description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode."
+},
+"hybridIngestionDisabled": {
+"description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.",
+"type": "boolean"
+},
+"identityRefreshInterval": {
+"deprecated": true,
+"description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
+"format": "google-duration",
+"type": "string"
+},
+"identityScheduleConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig",
+"description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector."
+},
+"incrementalRefreshInterval": {
+"description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.",
+"format": "google-duration",
+"type": "string"
+},
+"incrementalSyncDisabled": {
+"description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.",
+"type": "boolean"
+},
+"jsonParams": {
+"description": "Required data connector parameters in json string format.",
+"type": "string"
+},
+"kmsKeyName": {
+"description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.",
+"type": "string"
+},
+"lastSyncTime": {
+"description": "Output only. For periodic connectors only, the last time a data sync was completed.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"latestPauseTime": {
+"description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
+"readOnly": true,
+"type": "string"
+},
+"nextSyncTime": {
+"$ref": "GoogleTypeDateTime",
+"description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity."
+},
+"params": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required data connector parameters in structured json format.",
+"type": "object"
+},
+"privateConnectivityProjectId": {
+"description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.",
+"readOnly": true,
+"type": "string"
+},
+"realtimeState": {
+"description": "Output only. real-time sync state",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"FAILED",
+"RUNNING",
+"WARNING",
+"INITIALIZATION_FAILED",
+"UPDATING"
+],
+"enumDescriptions": [
+"Default value.",
+"The connector is being set up.",
+"The connector is successfully set up and awaiting next sync run.",
+"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
+"The connector is actively syncing records from the data source.",
+"The connector has completed a sync run, but encountered non-fatal errors.",
+"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
+"Connector is in the process of an update."
+],
+"readOnly": true,
+"type": "string"
+},
+"realtimeSyncConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig",
+"description": "Optional. The configuration for realtime sync."
+},
+"refreshInterval": {
+"description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.",
+"format": "google-duration",
+"type": "string"
+},
+"removeParamKeys": {
+"description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"state": {
+"description": "Output only. State of the connector.",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"FAILED",
+"RUNNING",
+"WARNING",
+"INITIALIZATION_FAILED",
+"UPDATING"
+],
+"enumDescriptions": [
+"Default value.",
+"The connector is being set up.",
+"The connector is successfully set up and awaiting next sync run.",
+"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
+"The connector is actively syncing records from the data source.",
+"The connector has completed a sync run, but encountered non-fatal errors.",
+"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
+"Connector is in the process of an update."
+],
+"readOnly": true,
+"type": "string"
+},
+"staticIpAddresses": {
+"description": "Output only. The static IP addresses used by this connector.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"staticIpEnabled": {
+"description": "Optional. Whether customer has enabled static IP addresses for this connector.",
+"type": "boolean"
+},
+"syncMode": {
+"description": "The data synchronization mode supported by the data connector.",
+"enum": [
+"PERIODIC",
+"STREAMING",
+"UNSPECIFIED"
+],
+"enumDescriptions": [
+"The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.",
+"The data will be synced in real time.",
+"Connector that doesn't ingest data will have this value"
+],
+"type": "string"
+},
+"updateTime": {
+"description": "Output only. Timestamp the DataConnector was last updated.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": {
+"description": "Any params and credentials used specifically for EUA connectors.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig",
+"properties": {
+"additionalParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any additional parameters needed for EUA.",
+"type": "object"
+},
+"authParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any authentication parameters specific to EUA connectors.",
+"type": "object"
+},
+"tenant": {
+"$ref": "GoogleCloudDiscoveryengineV1Tenant",
+"description": "Optional. The tenant project the connector is connected to."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig": {
+"description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig",
+"properties": {
+"additionalParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any additional parameters needed for FEDERATED.",
+"type": "object"
+},
+"authParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any authentication parameters specific to FEDERATED.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig": {
+"description": "The configuration for realtime sync to store additional params for realtime sync.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig",
+"properties": {
+"realtimeSyncSecret": {
+"description": "Optional. The ID of the Secret Manager secret used for webhook secret.",
+"type": "string"
+},
+"streamingError": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError",
+"description": "Optional. Streaming error details."
+},
+"webhookUri": {
+"description": "Optional. Webhook url for the connector to specify additional params for realtime sync.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError": {
+"description": "Streaming error details.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError",
+"properties": {
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Optional. Error details."
+},
+"streamingErrorReason": {
+"description": "Optional. Streaming error.",
+"enum": [
+"STREAMING_ERROR_REASON_UNSPECIFIED",
+"STREAMING_SETUP_ERROR",
+"STREAMING_SYNC_ERROR",
+"INGRESS_ENDPOINT_REQUIRED"
+],
+"enumDescriptions": [
+"Streaming error reason unspecified.",
+"Some error occurred while setting up resources for realtime sync.",
+"Some error was encountered while running realtime sync for the connector.",
+"Ingress endpoint is required when setting up realtime sync in private connectivity."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorSourceEntity": {
+"description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity",
+"properties": {
+"dataStore": {
+"description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.",
+"readOnly": true,
+"type": "string"
+},
+"entityName": {
+"description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`",
 "type": "string"
 },
-"name": {
-"description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.",
+"healthcareFhirConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig",
+"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
+},
+"jsonParams": {
+"description": "The parameters for the entity to facilitate data ingestion in json string format.",
 "type": "string"
 },
-"trainingStartTime": {
-"description": "Timestamp the model training was initiated.",
-"format": "google-datetime",
+"keyPropertyMappings": {
+"additionalProperties": {
 "type": "string"
+},
+"description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.",
+"type": "object"
+},
+"params": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "The parameters for the entity to facilitate data ingestion in structured json format.",
+"type": "object"
+},
+"startingSchema": {
+"$ref": "GoogleCloudDiscoveryengineV1Schema",
+"description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
 }
 },
 "type": "object"
@@ -12023,6 +12774,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1DeleteCollectionMetadata": {
+"description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": {
 "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata",
@@ -12125,6 +12893,52 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1DestinationConfig": {
+"description": "Defines target endpoints used to connect to third-party sources.",
+"id": "GoogleCloudDiscoveryengineV1DestinationConfig",
+"properties": {
+"destinations": {
+"description": "Optional. The destinations for the corresponding key.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1DestinationConfigDestination"
+},
+"type": "array"
+},
+"jsonParams": {
+"description": "Additional parameters for this destination config in json string format.",
+"type": "string"
+},
+"key": {
+"description": "Optional. Unique destination identifier that is supported by the connector.",
+"type": "string"
+},
+"params": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Additional parameters for this destination config in structured json format.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DestinationConfigDestination": {
+"description": "Defines a target endpoint",
+"id": "GoogleCloudDiscoveryengineV1DestinationConfigDestination",
+"properties": {
+"host": {
+"description": "Publicly routable host.",
+"type": "string"
+},
+"port": {
+"description": "Optional. Target port number accepted by the destination.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata",
@@ -12550,6 +13364,18 @@
 "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig",
 "description": "Common config spec that specifies the metadata of the engine."
 },
+"configurableBillingApproach": {
+"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.",
+"enum": [
+"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
+"CONFIGURABLE_BILLING_APPROACH_ENABLED"
+],
+"enumDescriptions": [
+"Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.",
+"The billing approach follows configurations specified by customer."
+],
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp the Recommendation Engine was created at.",
 "format": "google-datetime",
@@ -12585,7 +13411,7 @@
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`",
 "type": "object"
 },
 "industryVertical": {
@@ -13082,6 +13908,22 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1IdentityScheduleConfig": {
+"description": "The configuration for the identity data synchronization runs.",
+"id": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig",
+"properties": {
+"nextSyncTime": {
+"$ref": "GoogleTypeDateTime",
+"description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day."
+},
+"refreshInterval": {
+"description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
+"format": "google-duration",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1IdpConfig": {
 "description": "Identity Provider Config.",
 "id": "GoogleCloudDiscoveryengineV1IdpConfig",
@@ -13913,6 +14755,10 @@
 "readOnly": true,
 "type": "string"
 },
+"customerProvidedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig",
+"description": "Optional. Customer provided configurations."
+},
 "name": {
 "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
 "readOnly": true,
@@ -13935,6 +14781,43 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": {
+"description": "Customer provided configurations.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig",
+"properties": {
+"notebooklmConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig",
+"description": "Optional. Configuration for NotebookLM settings."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig": {
+"description": "Configuration for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig",
+"properties": {
+"modelArmorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
+"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"properties": {
+"responseTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.",
+"type": "string"
+},
+"userPromptTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1ProjectServiceTerms": {
 "description": "Metadata about the terms of service.",
 "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms",
@@ -14008,6 +14891,10 @@
 "acceptBizQos": {
 "description": "Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].",
 "type": "boolean"
+},
+"isBiz": {
+"description": "Optional. Indicates if the current request is for Biz edition (= true) or not (= false).",
+"type": "boolean"
 }
 },
 "type": "object"
@@ -14664,7 +15551,7 @@
 "type": "string"
 },
 "offset": {
-"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
 "format": "int32",
 "type": "integer"
 },
@@ -15963,6 +16850,31 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata": {
+"description": "Metadata for DataConnectorService.SetUpDataConnector method.",
+"id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata",
+"properties": {},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest": {
+"description": "Request for DataConnectorService.SetUpDataConnector method.",
+"id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorRequest",
+"properties": {
+"collectionDisplayName": {
+"description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.",
+"type": "string"
+},
+"collectionId": {
+"description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
+"type": "string"
+},
+"dataConnector": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnector",
+"description": "Required. The DataConnector to initialize in the newly created Collection."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1SingleRegionKey": {
 "description": "Metadata for single-regional CMEKs.",
 "id": "GoogleCloudDiscoveryengineV1SingleRegionKey",
@@ -16320,6 +17232,25 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1Tenant": {
+"description": "Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.",
+"id": "GoogleCloudDiscoveryengineV1Tenant",
+"properties": {
+"displayName": {
+"description": "Optional display name for the tenant, e.g. \"My Slack Team\".",
+"type": "string"
+},
+"id": {
+"description": "The tenant's instance ID. Examples: Jira (\"8594f221-9797-5f78-1fa4-485e198d7cd0\"), Slack (\"T123456\").",
+"type": "string"
+},
+"uri": {
+"description": "The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1TextInput": {
 "description": "Defines text input.",
 "id": "GoogleCloudDiscoveryengineV1TextInput",
@@ -18508,6 +19439,10 @@ false
 "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.",
 "type": "boolean"
 },
+"jsonParams": {
+"description": "Required data connector parameters in json string format.",
+"type": "string"
+},
 "kmsKeyName": {
 "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.",
 "type": "string"
@@ -18538,7 +19473,7 @@ false
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
+"description": "Required data connector parameters in structured json format.",
 "type": "object"
 },
 "privateConnectivityProjectId": {
@@ -18760,6 +19695,10 @@ false
 "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
 "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
 },
+"jsonParams": {
+"description": "The parameters for the entity to facilitate data ingestion in json string format.",
+"type": "string"
+},
 "keyPropertyMappings": {
 "additionalProperties": {
 "type": "string"
@@ -18772,7 +19711,7 @@ false
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.",
+"description": "The parameters for the entity to facilitate data ingestion in structured json format.",
 "type": "object"
 },
 "startingSchema": {
@@ -19155,6 +20094,10 @@ false
 },
 "type": "array"
 },
+"jsonParams": {
+"description": "Additional parameters for this destination config in json string format.",
+"type": "string"
+},
 "key": {
 "description": "Optional. Unique destination identifier that is supported by the connector.",
 "type": "string"
@@ -19164,7 +20107,7 @@ false
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "Optional. Additional parameters for this destination config.",
+"description": "Optional. Additional parameters for this destination config in structured json format.",
 "type": "object"
 }
 },
@@ -19405,6 +20348,18 @@ false
 "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig",
 "description": "Common config spec that specifies the metadata of the engine."
 },
+"configurableBillingApproach": {
+"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.",
+"enum": [
+"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
+"CONFIGURABLE_BILLING_APPROACH_ENABLED"
+],
+"enumDescriptions": [
+"Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.",
+"The billing approach follows configurations specified by customer."
+],
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp the Recommendation Engine was created at.",
 "format": "google-datetime",
@@ -19440,7 +20395,7 @@ false
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`",
 "type": "object"
 },
 "industryVertical": {
@@ -20626,6 +21581,10 @@ false
 "readOnly": true,
 "type": "string"
 },
+"customerProvidedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig",
+"description": "Optional. Customer provided configurations."
+},
 "name": {
 "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
 "readOnly": true,
@@ -20648,6 +21607,43 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": {
+"description": "Customer provided configurations.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig",
+"properties": {
+"notebooklmConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig",
+"description": "Optional. Configuration for NotebookLM settings."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig": {
+"description": "Configuration for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig",
+"properties": {
+"modelArmorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
+"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"properties": {
+"responseTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.",
+"type": "string"
+},
+"userPromptTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": {
 "description": "Metadata about the terms of service.",
 "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms",
@@ -21314,7 +22310,7 @@ false
 "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
 },
 "offset": {
-"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
 "format": "int32",
 "type": "integer"
 },
@@ -21414,6 +22410,10 @@ false
 "description": "Whether to turn on safe search. This is only supported for website search.",
 "type": "boolean"
 },
+"searchAddonSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec",
+"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests."
+},
 "searchAsYouTypeSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
 "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
@@ -21920,6 +22920,13 @@ false
 "description": "Specification to enable natural language understanding capabilities for search requests.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
 "properties": {
+"allowedFieldNames": {
+"description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "extractedFilterBehavior": {
 "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.",
 "enum": [
@@ -22015,6 +23022,25 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": {
+"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec",
+"properties": {
+"disableGenerativeAnswerAddOn": {
+"description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.",
+"type": "boolean"
+},
+"disableKpiPersonalizationAddOn": {
+"description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.",
+"type": "boolean"
+},
+"disableSemanticAddOn": {
+"description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": {
 "description": "Specification for search as you type in search requests.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
@@ -23799,6 +24825,18 @@ false
 "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig",
 "description": "Common config spec that specifies the metadata of the engine."
 },
+"configurableBillingApproach": {
+"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.",
+"enum": [
+"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
+"CONFIGURABLE_BILLING_APPROACH_ENABLED"
+],
+"enumDescriptions": [
+"Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.",
+"The billing approach follows configurations specified by customer."
+],
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp the Recommendation Engine was created at.",
 "format": "google-datetime",
@@ -23834,7 +24872,7 @@ false
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`",
 "type": "object"
 },
 "industryVertical": {
@@ -24645,6 +25683,10 @@ false
 "readOnly": true,
 "type": "string"
 },
+"customerProvidedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig",
+"description": "Optional. Customer provided configurations."
+},
 "name": {
 "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
 "readOnly": true,
@@ -24667,6 +25709,43 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": {
+"description": "Customer provided configurations.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig",
+"properties": {
+"notebooklmConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig",
+"description": "Optional. Configuration for NotebookLM settings."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig": {
+"description": "Configuration for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig",
+"properties": {
+"modelArmorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
+"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"properties": {
+"responseTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.",
+"type": "string"
+},
+"userPromptTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": {
 "description": "Metadata about the terms of service.",
 "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms",
@@ -25011,7 +26090,7 @@ false
 "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
 },
 "offset": {
-"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
 "format": "int32",
 "type": "integer"
 },
@@ -25111,6 +26190,10 @@ false
 "description": "Whether to turn on safe search. This is only supported for website search.",
 "type": "boolean"
 },
+"searchAddonSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec",
+"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests."
+},
 "searchAsYouTypeSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
 "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
@@ -25613,6 +26696,13 @@ false
 "description": "Specification to enable natural language understanding capabilities for search requests.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
 "properties": {
+"allowedFieldNames": {
+"description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "extractedFilterBehavior": {
 "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.",
 "enum": [
@@ -25708,6 +26798,25 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": {
+"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec",
+"properties": {
+"disableGenerativeAnswerAddOn": {
+"description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.",
+"type": "boolean"
+},
+"disableKpiPersonalizationAddOn": {
+"description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.",
+"type": "boolean"
+},
+"disableSemanticAddOn": {
+"description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": {
 "description": "Specification for search as you type in search requests.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
index 6348ebb6a4a..2ed5323659c 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json
@@ -203,6 +203,40 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"patch": {
+"description": "Updates the editable settings of a Discovery Engine Project.",
+"flatPath": "v1alpha/projects/{projectsId}",
+"httpMethod": "PATCH",
+"id": "discoveryengine.projects.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
+"location": "path",
+"pattern": "^projects/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. The list of fields to update. Supported fields: * `customer_provided_config`",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProject"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProject"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "provision": {
 "description": "Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.",
 "flatPath": "v1alpha/projects/{projectsId}:provision",
@@ -453,6 +487,44 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"setUpDataConnectorV2": {
+"description": "Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:setUpDataConnectorV2",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.setUpDataConnectorV2",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"collectionDisplayName": {
+"description": "Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.",
+"location": "query",
+"type": "string"
+},
+"collectionId": {
+"description": "Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}:setUpDataConnectorV2",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "updateAclConfig": {
 "description": "Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.",
 "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig",
@@ -9676,7 +9748,7 @@
 }
 }
 },
-"revision": "20250908",
+"revision": "20250918",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "ApiservingMediaRequestInfo": {
@@ -9719,6 +9791,11 @@
 ],
 "type": "string"
 },
+"physicalHeaders": {
+"description": "The physical headers provided by RequestReceivedParameters in Scotty request. type is uploader_service.KeyValuePairs.",
+"format": "byte",
+"type": "string"
+},
 "requestId": {
 "description": "The Scotty request ID.",
 "type": "string"
@@ -10699,6 +10776,34 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1ActionConfig": {
+"description": "Informations to support actions on the connector.",
+"id": "GoogleCloudDiscoveryengineV1ActionConfig",
+"properties": {
+"actionParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
+"type": "object"
+},
+"isActionConfigured": {
+"description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
+"readOnly": true,
+"type": "boolean"
+},
+"serviceName": {
+"description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.",
+"type": "string"
+},
+"useStaticSecrets": {
+"description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": {
 "description": "Configuration data for advance site search.",
 "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig",
@@ -10714,6 +10819,49 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1AlertPolicyConfig": {
+"description": "The connector level alert config.",
+"id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig",
+"properties": {
+"alertEnrollments": {
+"description": "Optional. The enrollment states of each alert.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment"
+},
+"type": "array"
+},
+"alertPolicyName": {
+"description": "Immutable. The fully qualified resource name of the AlertPolicy.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment": {
+"description": "The alert enrollment status.",
+"id": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment",
+"properties": {
+"alertId": {
+"description": "Immutable. The id of an alert.",
+"type": "string"
+},
+"enrollState": {
+"description": "Required. The enrollment status of a customer.",
+"enum": [
+"ENROLL_STATES_UNSPECIFIED",
+"ENROLLED",
+"DECLINED"
+],
+"enumDescriptions": [
+"Default value. Used for customers who have not responded to the alert policy.",
+"Customer is enrolled in this policy.",
+"Customer declined this policy."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": {
 "description": "The specification for answer generation.",
 "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec",
@@ -10941,6 +11089,32 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1BAPConfig": {
+"description": "The configuration for the BAP connector.",
+"id": "GoogleCloudDiscoveryengineV1BAPConfig",
+"properties": {
+"supportedConnectorModes": {
+"description": "Required. The supported connector modes for the associated BAP connection.",
+"items": {
+"enum": [
+"CONNECTOR_MODE_UNSPECIFIED",
+"DATA_INGESTION",
+"ACTIONS",
+"END_USER_AUTHENTICATION"
+],
+"enumDescriptions": [
+"Connector mode unspecified.",
+"Connector utilized for data ingestion.",
+"Connector utilized for Actions",
+"Connector utilized for End User Authentication."
+],
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata",
@@ -11102,6 +11276,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1Collection": {
+"description": "Collection is a container for configuring resources and access to a set of DataStores.",
+"id": "GoogleCloudDiscoveryengineV1Collection",
+"properties": {
+"createTime": {
+"description": "Output only. Timestamp the Collection was created at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"displayName": {
+"description": "Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
+"type": "string"
+},
+"name": {
+"description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1Condition": {
 "description": "Defines circumstances to be checked before allowing a behavior",
 "id": "GoogleCloudDiscoveryengineV1Condition",
@@ -11453,23 +11648,500 @@
 "description": "Operation last update time. If the operation is done, this is also the finish time.",
 "format": "google-datetime",
 "type": "string"
-}
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": {
+"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnector": {
+"description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.",
+"id": "GoogleCloudDiscoveryengineV1DataConnector",
+"properties": {
+"aclEnabled": {
+"description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.",
+"type": "boolean"
+},
+"actionConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ActionConfig",
+"description": "Optional. Action configurations to make the connector support actions."
+},
+"actionState": {
+"description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"FAILED",
+"RUNNING",
+"WARNING",
+"INITIALIZATION_FAILED",
+"UPDATING"
+],
+"enumDescriptions": [
+"Default value.",
+"The connector is being set up.",
+"The connector is successfully set up and awaiting next sync run.",
+"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
+"The connector is actively syncing records from the data source.",
+"The connector has completed a sync run, but encountered non-fatal errors.",
+"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
+"Connector is in the process of an update."
+],
+"readOnly": true,
+"type": "string"
+},
+"alertPolicyConfigs": {
+"description": "Optional. The connector level alert config.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfig"
+},
+"type": "array"
+},
+"autoRunDisabled": {
+"description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs",
+"type": "boolean"
+},
+"bapConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1BAPConfig",
+"description": "Optional. The configuration for establishing a BAP connection."
+},
+"blockingReasons": {
+"description": "Output only. User actions that must be completed before the connector can start syncing data.",
+"items": {
+"enum": [
+"BLOCKING_REASON_UNSPECIFIED",
+"ALLOWLIST_STATIC_IP",
+"ALLOWLIST_IN_SERVICE_ATTACHMENT",
+"ALLOWLIST_SERVICE_ACCOUNT"
+],
+"enumDescriptions": [
+"Default value.",
+"Connector requires customer to allowlist static IPs.",
+"Connector requires customer to allowlist our project in their service attachment.",
+"Connector requires customer to allowlist service account in their project."
+],
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"connectorModes": {
+"description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
+"items": {
+"enum": [
+"CONNECTOR_MODE_UNSPECIFIED",
+"DATA_INGESTION",
+"ACTIONS",
+"FEDERATED",
+"EUA",
+"FEDERATED_AND_EUA"
+],
+"enumDescriptions": [
+"Connector mode unspecified.",
+"Connector utilized for data ingestion.",
+"Connector utilized for actions.",
+"Connector utilized for federated search.",
+"Connector utilized for End User Authentication.",
+"Hybrid connector utilized for federated search and End User Authentication."
+],
+"type": "string"
+},
+"type": "array"
+},
+"connectorType": {
+"description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.",
+"enum": [
+"CONNECTOR_TYPE_UNSPECIFIED",
+"THIRD_PARTY",
+"GCP_FHIR",
+"BIG_QUERY",
+"GCS",
+"GOOGLE_MAIL",
+"GOOGLE_CALENDAR",
+"GOOGLE_DRIVE",
+"NATIVE_CLOUD_IDENTITY",
+"THIRD_PARTY_FEDERATED",
+"THIRD_PARTY_EUA",
+"GCNV"
+],
+"enumDescriptions": [
+"Default value.",
+"Third party connector to connector to third party application.",
+"Data connector connects between FHIR store and VAIS datastore.",
+"Big query connector.",
+"Google Cloud Storage connector.",
+"Gmail connector.",
+"Google Calendar connector.",
+"Google Drive connector.",
+"Native Cloud Identity connector for people search powered by People API.",
+"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
+"Connector utilized for End User Authentication features.",
+"Google Cloud NetApp Volumes connector."
+],
+"readOnly": true,
+"type": "string"
+},
+"createEuaSaas": {
+"description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.",
+"type": "boolean"
+},
+"createTime": {
+"description": "Output only. Timestamp the DataConnector was created at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"dataSource": {
+"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.",
+"type": "string"
+},
+"destinationConfigs": {
+"description": "Optional. Any target destinations used to connect to third-party services.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1DestinationConfig"
+},
+"type": "array"
+},
+"endUserConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig",
+"description": "Optional. Any params and credentials used specifically for EUA connectors."
+},
+"entities": {
+"description": "List of entities from the connected data source to ingest.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity"
+},
+"type": "array"
+},
+"errors": {
+"description": "Output only. The errors from initialization or from the latest connector run.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"readOnly": true,
+"type": "array"
+},
+"federatedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig",
+"description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode."
+},
+"hybridIngestionDisabled": {
+"description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.",
+"type": "boolean"
+},
+"identityRefreshInterval": {
+"deprecated": true,
+"description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
+"format": "google-duration",
+"type": "string"
+},
+"identityScheduleConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig",
+"description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector."
+},
+"incrementalRefreshInterval": {
+"description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.",
+"format": "google-duration",
+"type": "string"
+},
+"incrementalSyncDisabled": {
+"description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.",
+"type": "boolean"
+},
+"jsonParams": {
+"description": "Required data connector parameters in json string format.",
+"type": "string"
+},
+"kmsKeyName": {
+"description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.",
+"type": "string"
+},
+"lastSyncTime": {
+"description": "Output only. For periodic connectors only, the last time a data sync was completed.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"latestPauseTime": {
+"description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
+"readOnly": true,
+"type": "string"
+},
+"nextSyncTime": {
+"$ref": "GoogleTypeDateTime",
+"description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity."
+},
+"params": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required data connector parameters in structured json format.",
+"type": "object"
+},
+"privateConnectivityProjectId": {
+"description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.",
+"readOnly": true,
+"type": "string"
+},
+"realtimeState": {
+"description": "Output only. real-time sync state",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"FAILED",
+"RUNNING",
+"WARNING",
+"INITIALIZATION_FAILED",
+"UPDATING"
+],
+"enumDescriptions": [
+"Default value.",
+"The connector is being set up.",
+"The connector is successfully set up and awaiting next sync run.",
+"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
+"The connector is actively syncing records from the data source.",
+"The connector has completed a sync run, but encountered non-fatal errors.",
+"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
+"Connector is in the process of an update."
+],
+"readOnly": true,
+"type": "string"
+},
+"realtimeSyncConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig",
+"description": "Optional. The configuration for realtime sync."
+},
+"refreshInterval": {
+"description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.",
+"format": "google-duration",
+"type": "string"
+},
+"removeParamKeys": {
+"description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"state": {
+"description": "Output only. State of the connector.",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"FAILED",
+"RUNNING",
+"WARNING",
+"INITIALIZATION_FAILED",
+"UPDATING"
+],
+"enumDescriptions": [
+"Default value.",
+"The connector is being set up.",
+"The connector is successfully set up and awaiting next sync run.",
+"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
+"The connector is actively syncing records from the data source.",
+"The connector has completed a sync run, but encountered non-fatal errors.",
+"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
+"Connector is in the process of an update."
+],
+"readOnly": true,
+"type": "string"
+},
+"staticIpAddresses": {
+"description": "Output only. The static IP addresses used by this connector.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"staticIpEnabled": {
+"description": "Optional. Whether customer has enabled static IP addresses for this connector.",
+"type": "boolean"
+},
+"syncMode": {
+"description": "The data synchronization mode supported by the data connector.",
+"enum": [
+"PERIODIC",
+"STREAMING",
+"UNSPECIFIED"
+],
+"enumDescriptions": [
+"The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.",
+"The data will be synced in real time.",
+"Connector that doesn't ingest data will have this value"
+],
+"type": "string"
+},
+"updateTime": {
+"description": "Output only. Timestamp the DataConnector was last updated.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": {
+"description": "Any params and credentials used specifically for EUA connectors.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig",
+"properties": {
+"additionalParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any additional parameters needed for EUA.",
+"type": "object"
+},
+"authParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any authentication parameters specific to EUA connectors.",
+"type": "object"
+},
+"tenant": {
+"$ref": "GoogleCloudDiscoveryengineV1Tenant",
+"description": "Optional. The tenant project the connector is connected to."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig": {
+"description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig",
+"properties": {
+"additionalParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any additional parameters needed for FEDERATED.",
+"type": "object"
+},
+"authParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any authentication parameters specific to FEDERATED.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig": {
+"description": "The configuration for realtime sync to store additional params for realtime sync.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig",
+"properties": {
+"realtimeSyncSecret": {
+"description": "Optional. The ID of the Secret Manager secret used for webhook secret.",
+"type": "string"
+},
+"streamingError": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError",
+"description": "Optional. Streaming error details."
+},
+"webhookUri": {
+"description": "Optional. Webhook url for the connector to specify additional params for realtime sync.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError": {
+"description": "Streaming error details.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError",
+"properties": {
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Optional. Error details."
+},
+"streamingErrorReason": {
+"description": "Optional. Streaming error.",
+"enum": [
+"STREAMING_ERROR_REASON_UNSPECIFIED",
+"STREAMING_SETUP_ERROR",
+"STREAMING_SYNC_ERROR",
+"INGRESS_ENDPOINT_REQUIRED"
+],
+"enumDescriptions": [
+"Streaming error reason unspecified.",
+"Some error occurred while setting up resources for realtime sync.",
+"Some error was encountered while running realtime sync for the connector.",
+"Ingress endpoint is required when setting up realtime sync in private connectivity."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorSourceEntity": {
+"description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity",
+"properties": {
+"dataStore": {
+"description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.",
+"readOnly": true,
+"type": "string"
+},
+"entityName": {
+"description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`",
+"type": "string"
+},
+"healthcareFhirConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig",
+"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
+},
+"jsonParams": {
+"description": "The parameters for the entity to facilitate data ingestion in json string format.",
+"type": "string"
+},
+"keyPropertyMappings": {
+"additionalProperties": {
+"type": "string"
 },
+"description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.",
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": {
-"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
-"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata",
-"properties": {
-"createTime": {
-"description": "Operation create time.",
-"format": "google-datetime",
-"type": "string"
+"params": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
 },
-"updateTime": {
-"description": "Operation last update time. If the operation is done, this is also the finish time.",
-"format": "google-datetime",
-"type": "string"
+"description": "The parameters for the entity to facilitate data ingestion in structured json format.",
+"type": "object"
+},
+"startingSchema": {
+"$ref": "GoogleCloudDiscoveryengineV1Schema",
+"description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
 }
 },
 "type": "object"
@@ -11670,6 +12342,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1DeleteCollectionMetadata": {
+"description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": {
 "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata",
@@ -11772,6 +12461,52 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1DestinationConfig": {
+"description": "Defines target endpoints used to connect to third-party sources.",
+"id": "GoogleCloudDiscoveryengineV1DestinationConfig",
+"properties": {
+"destinations": {
+"description": "Optional. The destinations for the corresponding key.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1DestinationConfigDestination"
+},
+"type": "array"
+},
+"jsonParams": {
+"description": "Additional parameters for this destination config in json string format.",
+"type": "string"
+},
+"key": {
+"description": "Optional. Unique destination identifier that is supported by the connector.",
+"type": "string"
+},
+"params": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Additional parameters for this destination config in structured json format.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DestinationConfigDestination": {
+"description": "Defines a target endpoint",
+"id": "GoogleCloudDiscoveryengineV1DestinationConfigDestination",
+"properties": {
+"host": {
+"description": "Publicly routable host.",
+"type": "string"
+},
+"port": {
+"description": "Optional. Target port number accepted by the destination.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata",
@@ -11991,6 +12726,18 @@
 "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig",
 "description": "Common config spec that specifies the metadata of the engine."
 },
+"configurableBillingApproach": {
+"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.",
+"enum": [
+"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
+"CONFIGURABLE_BILLING_APPROACH_ENABLED"
+],
+"enumDescriptions": [
+"Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.",
+"The billing approach follows configurations specified by customer."
+],
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp the Recommendation Engine was created at.",
 "format": "google-datetime",
@@ -12026,7 +12773,7 @@
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`",
 "type": "object"
 },
 "industryVertical": {
@@ -12312,6 +13059,22 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1IdentityScheduleConfig": {
+"description": "The configuration for the identity data synchronization runs.",
+"id": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig",
+"properties": {
+"nextSyncTime": {
+"$ref": "GoogleTypeDateTime",
+"description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day."
+},
+"refreshInterval": {
+"description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
+"format": "google-duration",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1IdpConfig": {
 "description": "Identity Provider Config.",
 "id": "GoogleCloudDiscoveryengineV1IdpConfig",
@@ -12574,6 +13337,10 @@
 "readOnly": true,
 "type": "string"
 },
+"customerProvidedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig",
+"description": "Optional. Customer provided configurations."
+},
 "name": {
 "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
 "readOnly": true,
@@ -12596,6 +13363,43 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": {
+"description": "Customer provided configurations.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig",
+"properties": {
+"notebooklmConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig",
+"description": "Optional. Configuration for NotebookLM settings."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig": {
+"description": "Configuration for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig",
+"properties": {
+"modelArmorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
+"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"properties": {
+"responseTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.",
+"type": "string"
+},
+"userPromptTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1ProjectServiceTerms": {
 "description": "Metadata about the terms of service.",
 "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms",
@@ -13170,6 +13974,12 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata": {
+"description": "Metadata for DataConnectorService.SetUpDataConnector method.",
+"id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata",
+"properties": {},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1SingleRegionKey": {
 "description": "Metadata for single-regional CMEKs.",
 "id": "GoogleCloudDiscoveryengineV1SingleRegionKey",
@@ -13337,6 +14147,25 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1Tenant": {
+"description": "Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.",
+"id": "GoogleCloudDiscoveryengineV1Tenant",
+"properties": {
+"displayName": {
+"description": "Optional display name for the tenant, e.g. \"My Slack Team\".",
+"type": "string"
+},
+"id": {
+"description": "The tenant's instance ID. Examples: Jira (\"8594f221-9797-5f78-1fa4-485e198d7cd0\"), Slack (\"T123456\").",
+"type": "string"
+},
+"uri": {
+"description": "The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": {
 "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata",
@@ -15776,6 +16605,10 @@
 "description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.",
 "type": "string"
 },
+"mimeType": {
+"description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.",
+"type": "string"
+},
 "pageIdentifier": {
 "description": "Page identifier.",
 "type": "string"
@@ -17974,6 +18807,10 @@
 "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.",
 "type": "boolean"
 },
+"jsonParams": {
+"description": "Required data connector parameters in json string format.",
+"type": "string"
+},
 "kmsKeyName": {
 "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.",
 "type": "string"
@@ -18004,7 +18841,7 @@
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
+"description": "Required data connector parameters in structured json format.",
 "type": "object"
 },
 "privateConnectivityProjectId": {
@@ -18226,6 +19063,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
 "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
 },
+"jsonParams": {
+"description": "The parameters for the entity to facilitate data ingestion in json string format.",
+"type": "string"
+},
 "keyPropertyMappings": {
 "additionalProperties": {
 "type": "string"
@@ -18238,7 +19079,7 @@
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.",
+"description": "The parameters for the entity to facilitate data ingestion in structured json format.",
 "type": "object"
 },
 "startingSchema": {
@@ -18621,6 +19462,10 @@
 },
 "type": "array"
 },
+"jsonParams": {
+"description": "Additional parameters for this destination config in json string format.",
+"type": "string"
+},
 "key": {
 "description": "Optional. Unique destination identifier that is supported by the connector.",
 "type": "string"
@@ -18630,7 +19475,7 @@
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "Optional. Additional parameters for this destination config.",
+"description": "Optional. Additional parameters for this destination config in structured json format.",
 "type": "object"
 }
 },
@@ -19088,6 +19933,18 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig",
 "description": "Common config spec that specifies the metadata of the engine."
 },
+"configurableBillingApproach": {
+"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.",
+"enum": [
+"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
+"CONFIGURABLE_BILLING_APPROACH_ENABLED"
+],
+"enumDescriptions": [
+"Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.",
+"The billing approach follows configurations specified by customer."
+],
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp the Recommendation Engine was created at.",
 "format": "google-datetime",
@@ -19123,7 +19980,7 @@
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`",
 "type": "object"
 },
 "industryVertical": {
@@ -21642,6 +22499,10 @@
 "readOnly": true,
 "type": "string"
 },
+"customerProvidedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig",
+"description": "Optional. Customer provided configurations."
+},
 "name": {
 "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
 "readOnly": true,
@@ -21664,6 +22525,43 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": {
+"description": "Customer provided configurations.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig",
+"properties": {
+"notebooklmConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig",
+"description": "Optional. Configuration for NotebookLM settings."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig": {
+"description": "Configuration for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig",
+"properties": {
+"modelArmorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
+"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"properties": {
+"responseTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.",
+"type": "string"
+},
+"userPromptTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": {
 "description": "Metadata about the terms of service.",
 "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms",
@@ -21737,6 +22635,10 @@
 "acceptBizQos": {
 "description": "Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].",
 "type": "boolean"
+},
+"isBiz": {
+"description": "Optional. Indicates if the current request is for Biz edition (= true) or not (= false).",
+"type": "boolean"
 }
 },
 "type": "object"
@@ -23044,7 +23946,7 @@
 "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
 },
 "offset": {
-"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
 "format": "int32",
 "type": "integer"
 },
@@ -23144,6 +24046,10 @@ false
 "description": "Whether to turn on safe search. This is only supported for website search.",
 "type": "boolean"
 },
+"searchAddonSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec",
+"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests."
+},
 "searchAsYouTypeSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
 "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
@@ -23650,6 +24556,13 @@ false
 "description": "Specification to enable natural language understanding capabilities for search requests.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
 "properties": {
+"allowedFieldNames": {
+"description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "extractedFilterBehavior": {
 "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.",
 "enum": [
@@ -23745,6 +24658,25 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": {
+"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec",
+"properties": {
+"disableGenerativeAnswerAddOn": {
+"description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.",
+"type": "boolean"
+},
+"disableKpiPersonalizationAddOn": {
+"description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.",
+"type": "boolean"
+},
+"disableSemanticAddOn": {
+"description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": {
 "description": "Specification for search as you type in search requests.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
@@ -26583,6 +27515,10 @@ false
 "description": "Whether or not to enable autocomplete.",
 "type": "boolean"
 },
+"enableCreateAgentButton": {
+"description": "Optional. If set to true, the widget will enable the create agent button.",
+"type": "boolean"
+},
 "enablePeopleSearch": {
 "description": "Optional. If set to true, the widget will enable people search.",
 "type": "boolean"
@@ -26617,7 +27553,7 @@ false
 ],
 "type": "string"
 },
-"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
+"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`",
 "readOnly": true,
 "type": "object"
 },
@@ -27875,6 +28811,18 @@ false
 "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig",
 "description": "Common config spec that specifies the metadata of the engine."
 },
+"configurableBillingApproach": {
+"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.",
+"enum": [
+"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
+"CONFIGURABLE_BILLING_APPROACH_ENABLED"
+],
+"enumDescriptions": [
+"Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.",
+"The billing approach follows configurations specified by customer."
+],
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp the Recommendation Engine was created at.",
 "format": "google-datetime",
@@ -27910,7 +28858,7 @@ false
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`",
 "type": "object"
 },
 "industryVertical": {
@@ -28721,6 +29669,10 @@ false
 "readOnly": true,
 "type": "string"
 },
+"customerProvidedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig",
+"description": "Optional. Customer provided configurations."
+},
 "name": {
 "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
 "readOnly": true,
@@ -28743,6 +29695,43 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": {
+"description": "Customer provided configurations.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig",
+"properties": {
+"notebooklmConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig",
+"description": "Optional. Configuration for NotebookLM settings."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig": {
+"description": "Configuration for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig",
+"properties": {
+"modelArmorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
+"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"properties": {
+"responseTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.",
+"type": "string"
+},
+"userPromptTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": {
 "description": "Metadata about the terms of service.",
 "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms",
@@ -29087,7 +30076,7 @@ false
 "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
 },
 "offset": {
-"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
 "format": "int32",
 "type": "integer"
 },
@@ -29187,6 +30176,10 @@ false
 "description": "Whether to turn on safe search. This is only supported for website search.",
 "type": "boolean"
 },
+"searchAddonSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec",
+"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests."
+},
 "searchAsYouTypeSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
 "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
@@ -29689,6 +30682,13 @@ false
 "description": "Specification to enable natural language understanding capabilities for search requests.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
 "properties": {
+"allowedFieldNames": {
+"description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "extractedFilterBehavior": {
 "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.",
 "enum": [
@@ -29784,6 +30784,25 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": {
+"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec",
+"properties": {
+"disableGenerativeAnswerAddOn": {
+"description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.",
+"type": "boolean"
+},
+"disableKpiPersonalizationAddOn": {
+"description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.",
+"type": "boolean"
+},
+"disableSemanticAddOn": {
+"description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": {
 "description": "Specification for search as you type in search requests.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
@@ -30328,16 +31347,15 @@ false
 "description": "An audio overview of a notebook. This is a summary of the notebook in audio format.",
 "id": "GoogleCloudNotebooklmV1alphaAudioOverview",
 "properties": {
-"audio": {
-"description": "The audio overview in wav format. This is only present if the status is AUDIO_OVERVIEW_STATUS_COMPLETE.",
-"format": "byte",
-"type": "string"
-},
 "audioOverviewId": {
 "description": "Output only. Unique ID of the audio overview.",
 "readOnly": true,
 "type": "string"
 },
+"generationOptions": {
+"$ref": "GoogleCloudNotebooklmV1alphaAudioOverviewGenerationOptions",
+"description": "The options used to generate the audio overview."
+},
 "languageCode": {
 "description": "The language code of the generated audio overview. Use the BCP 47 language code (e.g. \"en\", \"es\", \"hi\", etc.).",
 "type": "string"
@@ -30360,10 +31378,6 @@ false
 "description": "Identifier. The full resource name of the notebook. Format: `projects/{project}/locations/{location}/notebooks/{notebook}/audioOverviews/{audio_overview_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
 "type": "string"
 },
-"playbackUrl": {
-"description": "The url used to play the audio overview.",
-"type": "string"
-},
 "status": {
 "description": "The status of the audio overview.",
 "enum": [
diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
index 71cc1c7b1ae..f4740c21c07 100644
--- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json
@@ -8200,7 +8200,7 @@
 }
 }
 },
-"revision": "20250908",
+"revision": "20250918",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GdataBlobstore2Info": {
@@ -9061,6 +9061,34 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1ActionConfig": {
+"description": "Informations to support actions on the connector.",
+"id": "GoogleCloudDiscoveryengineV1ActionConfig",
+"properties": {
+"actionParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
+"type": "object"
+},
+"isActionConfigured": {
+"description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
+"readOnly": true,
+"type": "boolean"
+},
+"serviceName": {
+"description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.",
+"type": "string"
+},
+"useStaticSecrets": {
+"description": "Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": {
 "description": "Configuration data for advance site search.",
 "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig",
@@ -9076,6 +9104,49 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1AlertPolicyConfig": {
+"description": "The connector level alert config.",
+"id": "GoogleCloudDiscoveryengineV1AlertPolicyConfig",
+"properties": {
+"alertEnrollments": {
+"description": "Optional. The enrollment states of each alert.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment"
+},
+"type": "array"
+},
+"alertPolicyName": {
+"description": "Immutable. The fully qualified resource name of the AlertPolicy.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment": {
+"description": "The alert enrollment status.",
+"id": "GoogleCloudDiscoveryengineV1AlertPolicyConfigAlertEnrollment",
+"properties": {
+"alertId": {
+"description": "Immutable. The id of an alert.",
+"type": "string"
+},
+"enrollState": {
+"description": "Required. The enrollment status of a customer.",
+"enum": [
+"ENROLL_STATES_UNSPECIFIED",
+"ENROLLED",
+"DECLINED"
+],
+"enumDescriptions": [
+"Default value. Used for customers who have not responded to the alert policy.",
+"Customer is enrolled in this policy.",
+"Customer declined this policy."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1AnswerGenerationSpec": {
 "description": "The specification for answer generation.",
 "id": "GoogleCloudDiscoveryengineV1AnswerGenerationSpec",
@@ -9303,6 +9374,32 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1BAPConfig": {
+"description": "The configuration for the BAP connector.",
+"id": "GoogleCloudDiscoveryengineV1BAPConfig",
+"properties": {
+"supportedConnectorModes": {
+"description": "Required. The supported connector modes for the associated BAP connection.",
+"items": {
+"enum": [
+"CONNECTOR_MODE_UNSPECIFIED",
+"DATA_INGESTION",
+"ACTIONS",
+"END_USER_AUTHENTICATION"
+],
+"enumDescriptions": [
+"Connector mode unspecified.",
+"Connector utilized for data ingestion.",
+"Connector utilized for Actions",
+"Connector utilized for End User Authentication."
+],
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata",
@@ -9464,6 +9561,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1Collection": {
+"description": "Collection is a container for configuring resources and access to a set of DataStores.",
+"id": "GoogleCloudDiscoveryengineV1Collection",
+"properties": {
+"createTime": {
+"description": "Output only. Timestamp the Collection was created at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"displayName": {
+"description": "Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
+"type": "string"
+},
+"name": {
+"description": "Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1Condition": {
 "description": "Defines circumstances to be checked before allowing a behavior",
 "id": "GoogleCloudDiscoveryengineV1Condition",
@@ -9798,40 +9916,517 @@
 "description": "Operation last update time. If the operation is done, this is also the finish time.",
 "format": "google-datetime",
 "type": "string"
-}
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1CreateSitemapMetadata": {
+"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": {
+"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnector": {
+"description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.",
+"id": "GoogleCloudDiscoveryengineV1DataConnector",
+"properties": {
+"aclEnabled": {
+"description": "Optional. Whether the connector will be created with an ACL config. Currently this field only affects Cloud Storage and BigQuery connectors.",
+"type": "boolean"
+},
+"actionConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ActionConfig",
+"description": "Optional. Action configurations to make the connector support actions."
+},
+"actionState": {
+"description": "Output only. State of the action connector. This reflects whether the action connector is initializing, active or has encountered errors.",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"FAILED",
+"RUNNING",
+"WARNING",
+"INITIALIZATION_FAILED",
+"UPDATING"
+],
+"enumDescriptions": [
+"Default value.",
+"The connector is being set up.",
+"The connector is successfully set up and awaiting next sync run.",
+"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
+"The connector is actively syncing records from the data source.",
+"The connector has completed a sync run, but encountered non-fatal errors.",
+"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
+"Connector is in the process of an update."
+],
+"readOnly": true,
+"type": "string"
+},
+"alertPolicyConfigs": {
+"description": "Optional. The connector level alert config.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1AlertPolicyConfig"
+},
+"type": "array"
+},
+"autoRunDisabled": {
+"description": "Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs",
+"type": "boolean"
+},
+"bapConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1BAPConfig",
+"description": "Optional. The configuration for establishing a BAP connection."
+},
+"blockingReasons": {
+"description": "Output only. User actions that must be completed before the connector can start syncing data.",
+"items": {
+"enum": [
+"BLOCKING_REASON_UNSPECIFIED",
+"ALLOWLIST_STATIC_IP",
+"ALLOWLIST_IN_SERVICE_ATTACHMENT",
+"ALLOWLIST_SERVICE_ACCOUNT"
+],
+"enumDescriptions": [
+"Default value.",
+"Connector requires customer to allowlist static IPs.",
+"Connector requires customer to allowlist our project in their service attachment.",
+"Connector requires customer to allowlist service account in their project."
+],
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"connectorModes": {
+"description": "Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED.",
+"items": {
+"enum": [
+"CONNECTOR_MODE_UNSPECIFIED",
+"DATA_INGESTION",
+"ACTIONS",
+"FEDERATED",
+"EUA",
+"FEDERATED_AND_EUA"
+],
+"enumDescriptions": [
+"Connector mode unspecified.",
+"Connector utilized for data ingestion.",
+"Connector utilized for actions.",
+"Connector utilized for federated search.",
+"Connector utilized for End User Authentication.",
+"Hybrid connector utilized for federated search and End User Authentication."
+],
+"type": "string"
+},
+"type": "array"
+},
+"connectorType": {
+"description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system.",
+"enum": [
+"CONNECTOR_TYPE_UNSPECIFIED",
+"THIRD_PARTY",
+"GCP_FHIR",
+"BIG_QUERY",
+"GCS",
+"GOOGLE_MAIL",
+"GOOGLE_CALENDAR",
+"GOOGLE_DRIVE",
+"NATIVE_CLOUD_IDENTITY",
+"THIRD_PARTY_FEDERATED",
+"THIRD_PARTY_EUA",
+"GCNV"
+],
+"enumDescriptions": [
+"Default value.",
+"Third party connector to connector to third party application.",
+"Data connector connects between FHIR store and VAIS datastore.",
+"Big query connector.",
+"Google Cloud Storage connector.",
+"Gmail connector.",
+"Google Calendar connector.",
+"Google Drive connector.",
+"Native Cloud Identity connector for people search powered by People API.",
+"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API.",
+"Connector utilized for End User Authentication features.",
+"Google Cloud NetApp Volumes connector."
+],
+"readOnly": true,
+"type": "string"
+},
+"createEuaSaas": {
+"description": "Optional. Whether the END USER AUTHENTICATION connector is created in SaaS.",
+"type": "boolean"
+},
+"createTime": {
+"description": "Output only. Timestamp the DataConnector was created at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"dataSource": {
+"description": "Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`.",
+"type": "string"
+},
+"destinationConfigs": {
+"description": "Optional. Any target destinations used to connect to third-party services.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1DestinationConfig"
+},
+"type": "array"
+},
+"endUserConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig",
+"description": "Optional. Any params and credentials used specifically for EUA connectors."
+},
+"entities": {
+"description": "List of entities from the connected data source to ingest.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity"
+},
+"type": "array"
+},
+"errors": {
+"description": "Output only. The errors from initialization or from the latest connector run.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"readOnly": true,
+"type": "array"
+},
+"federatedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig",
+"description": "Optional. Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode. This field should only be set if the connector is a hybrid connector and we want to enable FEDERATED mode."
+},
+"hybridIngestionDisabled": {
+"description": "Optional. If the connector is a hybrid connector, determines whether ingestion is enabled and appropriate resources are provisioned during connector creation. If the connector is not a hybrid connector, this field is ignored.",
+"type": "boolean"
+},
+"identityRefreshInterval": {
+"deprecated": true,
+"description": "The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
+"format": "google-duration",
+"type": "string"
+},
+"identityScheduleConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig",
+"description": "The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector."
+},
+"incrementalRefreshInterval": {
+"description": "Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.",
+"format": "google-duration",
+"type": "string"
+},
+"incrementalSyncDisabled": {
+"description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.",
+"type": "boolean"
+},
+"jsonParams": {
+"description": "Required data connector parameters in json string format.",
+"type": "string"
+},
+"kmsKeyName": {
+"description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.",
+"type": "string"
+},
+"lastSyncTime": {
+"description": "Output only. For periodic connectors only, the last time a data sync was completed.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"latestPauseTime": {
+"description": "Output only. The most recent timestamp when this DataConnector was paused, affecting all functionalities such as data synchronization. Pausing a connector has the following effects: - All functionalities, including data synchronization, are halted. - Any ongoing data synchronization job will be canceled. - No future data synchronization runs will be scheduled nor can be triggered.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. The full resource name of the Data Connector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
+"readOnly": true,
+"type": "string"
+},
+"nextSyncTime": {
+"$ref": "GoogleTypeDateTime",
+"description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity."
+},
+"params": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Required data connector parameters in structured json format.",
+"type": "object"
+},
+"privateConnectivityProjectId": {
+"description": "Output only. The tenant project ID associated with private connectivity connectors. This project must be allowlisted by in order for the connector to function.",
+"readOnly": true,
+"type": "string"
+},
+"realtimeState": {
+"description": "Output only. real-time sync state",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"FAILED",
+"RUNNING",
+"WARNING",
+"INITIALIZATION_FAILED",
+"UPDATING"
+],
+"enumDescriptions": [
+"Default value.",
+"The connector is being set up.",
+"The connector is successfully set up and awaiting next sync run.",
+"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
+"The connector is actively syncing records from the data source.",
+"The connector has completed a sync run, but encountered non-fatal errors.",
+"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
+"Connector is in the process of an update."
+],
+"readOnly": true,
+"type": "string"
+},
+"realtimeSyncConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig",
+"description": "Optional. The configuration for realtime sync."
+},
+"refreshInterval": {
+"description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled.",
+"format": "google-duration",
+"type": "string"
+},
+"removeParamKeys": {
+"description": "Optional. Specifies keys to be removed from the 'params' field. This is only active when 'params' is included in the 'update_mask' in an UpdateDataConnectorRequest. Deletion takes precedence if a key is both in 'remove_param_keys' and present in the 'params' field of the request.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"state": {
+"description": "Output only. State of the connector.",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"FAILED",
+"RUNNING",
+"WARNING",
+"INITIALIZATION_FAILED",
+"UPDATING"
+],
+"enumDescriptions": [
+"Default value.",
+"The connector is being set up.",
+"The connector is successfully set up and awaiting next sync run.",
+"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
+"The connector is actively syncing records from the data source.",
+"The connector has completed a sync run, but encountered non-fatal errors.",
+"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types).",
+"Connector is in the process of an update."
+],
+"readOnly": true,
+"type": "string"
+},
+"staticIpAddresses": {
+"description": "Output only. The static IP addresses used by this connector.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"staticIpEnabled": {
+"description": "Optional. Whether customer has enabled static IP addresses for this connector.",
+"type": "boolean"
+},
+"syncMode": {
+"description": "The data synchronization mode supported by the data connector.",
+"enum": [
+"PERIODIC",
+"STREAMING",
+"UNSPECIFIED"
+],
+"enumDescriptions": [
+"The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.",
+"The data will be synced in real time.",
+"Connector that doesn't ingest data will have this value"
+],
+"type": "string"
+},
+"updateTime": {
+"description": "Output only. Timestamp the DataConnector was last updated.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig": {
+"description": "Any params and credentials used specifically for EUA connectors.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig",
+"properties": {
+"additionalParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any additional parameters needed for EUA.",
+"type": "object"
+},
+"authParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any authentication parameters specific to EUA connectors.",
+"type": "object"
+},
+"tenant": {
+"$ref": "GoogleCloudDiscoveryengineV1Tenant",
+"description": "Optional. The tenant project the connector is connected to."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig": {
+"description": "Any params and credentials used specifically for hybrid connectors supporting FEDERATED mode.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorFederatedConfig",
+"properties": {
+"additionalParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any additional parameters needed for FEDERATED.",
+"type": "object"
+},
+"authParams": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Any authentication parameters specific to FEDERATED.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig": {
+"description": "The configuration for realtime sync to store additional params for realtime sync.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfig",
+"properties": {
+"realtimeSyncSecret": {
+"description": "Optional. The ID of the Secret Manager secret used for webhook secret.",
+"type": "string"
+},
+"streamingError": {
+"$ref": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError",
+"description": "Optional. Streaming error details."
+},
+"webhookUri": {
+"description": "Optional. Webhook url for the connector to specify additional params for realtime sync.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError": {
+"description": "Streaming error details.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorRealtimeSyncConfigStreamingError",
+"properties": {
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Optional. Error details."
+},
+"streamingErrorReason": {
+"description": "Optional. Streaming error.",
+"enum": [
+"STREAMING_ERROR_REASON_UNSPECIFIED",
+"STREAMING_SETUP_ERROR",
+"STREAMING_SYNC_ERROR",
+"INGRESS_ENDPOINT_REQUIRED"
+],
+"enumDescriptions": [
+"Streaming error reason unspecified.",
+"Some error occurred while setting up resources for realtime sync.",
+"Some error was encountered while running realtime sync for the connector.",
+"Ingress endpoint is required when setting up realtime sync in private connectivity."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DataConnectorSourceEntity": {
+"description": "Represents an entity in the data source. For example, the `Account` object in Salesforce.",
+"id": "GoogleCloudDiscoveryengineV1DataConnectorSourceEntity",
+"properties": {
+"dataStore": {
+"description": "Output only. The full resource name of the associated data store for the source entity. Format: `projects/*/locations/*/collections/*/dataStores/*`. When the connector is initialized by the DataConnectorService.SetUpDataConnector method, a DataStore is automatically created for each source entity.",
+"readOnly": true,
+"type": "string"
+},
+"entityName": {
+"description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`",
+"type": "string"
 },
-"type": "object"
+"healthcareFhirConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig",
+"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
 },
-"GoogleCloudDiscoveryengineV1CreateSitemapMetadata": {
-"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
-"id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata",
-"properties": {
-"createTime": {
-"description": "Operation create time.",
-"format": "google-datetime",
+"jsonParams": {
+"description": "The parameters for the entity to facilitate data ingestion in json string format.",
 "type": "string"
 },
-"updateTime": {
-"description": "Operation last update time. If the operation is done, this is also the finish time.",
-"format": "google-datetime",
+"keyPropertyMappings": {
+"additionalProperties": {
 "type": "string"
-}
 },
+"description": "Attributes for indexing. Key: Field name. Value: The key property to map a field to, such as `title`, and `description`. Supported key properties: * `title`: The title for data record. This would be displayed on search results. * `description`: The description for data record. This would be displayed on search results.",
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": {
-"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
-"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata",
-"properties": {
-"createTime": {
-"description": "Operation create time.",
-"format": "google-datetime",
-"type": "string"
+"params": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
 },
-"updateTime": {
-"description": "Operation last update time. If the operation is done, this is also the finish time.",
-"format": "google-datetime",
-"type": "string"
+"description": "The parameters for the entity to facilitate data ingestion in structured json format.",
+"type": "object"
+},
+"startingSchema": {
+"$ref": "GoogleCloudDiscoveryengineV1Schema",
+"description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
 }
 },
 "type": "object"
@@ -10032,6 +10627,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1DeleteCollectionMetadata": {
+"description": "Metadata related to the progress of the CollectionService.UpdateCollection operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1DeleteCollectionMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": {
 "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata",
@@ -10134,6 +10746,52 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1DestinationConfig": {
+"description": "Defines target endpoints used to connect to third-party sources.",
+"id": "GoogleCloudDiscoveryengineV1DestinationConfig",
+"properties": {
+"destinations": {
+"description": "Optional. The destinations for the corresponding key.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1DestinationConfigDestination"
+},
+"type": "array"
+},
+"jsonParams": {
+"description": "Additional parameters for this destination config in json string format.",
+"type": "string"
+},
+"key": {
+"description": "Optional. Unique destination identifier that is supported by the connector.",
+"type": "string"
+},
+"params": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. Additional parameters for this destination config in structured json format.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1DestinationConfigDestination": {
+"description": "Defines a target endpoint",
+"id": "GoogleCloudDiscoveryengineV1DestinationConfigDestination",
+"properties": {
+"host": {
+"description": "Publicly routable host.",
+"type": "string"
+},
+"port": {
+"description": "Optional. Target port number accepted by the destination.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata",
@@ -10353,6 +11011,18 @@
 "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig",
 "description": "Common config spec that specifies the metadata of the engine."
 },
+"configurableBillingApproach": {
+"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.",
+"enum": [
+"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
+"CONFIGURABLE_BILLING_APPROACH_ENABLED"
+],
+"enumDescriptions": [
+"Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.",
+"The billing approach follows configurations specified by customer."
+],
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp the Recommendation Engine was created at.",
 "format": "google-datetime",
@@ -10388,7 +11058,7 @@
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`",
 "type": "object"
 },
 "industryVertical": {
@@ -10674,6 +11344,22 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1IdentityScheduleConfig": {
+"description": "The configuration for the identity data synchronization runs.",
+"id": "GoogleCloudDiscoveryengineV1IdentityScheduleConfig",
+"properties": {
+"nextSyncTime": {
+"$ref": "GoogleTypeDateTime",
+"description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day."
+},
+"refreshInterval": {
+"description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
+"format": "google-duration",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1IdpConfig": {
 "description": "Identity Provider Config.",
 "id": "GoogleCloudDiscoveryengineV1IdpConfig",
@@ -10936,6 +11622,10 @@
 "readOnly": true,
 "type": "string"
 },
+"customerProvidedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig",
+"description": "Optional. Customer provided configurations."
+},
 "name": {
 "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
 "readOnly": true,
@@ -10958,6 +11648,43 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig": {
+"description": "Customer provided configurations.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfig",
+"properties": {
+"notebooklmConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig",
+"description": "Optional. Configuration for NotebookLM settings."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig": {
+"description": "Configuration for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig",
+"properties": {
+"modelArmorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
+"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
+"id": "GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"properties": {
+"responseTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.",
+"type": "string"
+},
+"userPromptTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1ProjectServiceTerms": {
 "description": "Metadata about the terms of service.",
 "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms",
@@ -11532,6 +12259,12 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata": {
+"description": "Metadata for DataConnectorService.SetUpDataConnector method.",
+"id": "GoogleCloudDiscoveryengineV1SetUpDataConnectorMetadata",
+"properties": {},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1SingleRegionKey": {
 "description": "Metadata for single-regional CMEKs.",
 "id": "GoogleCloudDiscoveryengineV1SingleRegionKey",
@@ -11699,6 +12432,25 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1Tenant": {
+"description": "Tenant information for a connector source. This includes some of the same information stored in the Credential message, but is limited to only what is needed to provide a list of accessible tenants to the user.",
+"id": "GoogleCloudDiscoveryengineV1Tenant",
+"properties": {
+"displayName": {
+"description": "Optional display name for the tenant, e.g. \"My Slack Team\".",
+"type": "string"
+},
+"id": {
+"description": "The tenant's instance ID. Examples: Jira (\"8594f221-9797-5f78-1fa4-485e198d7cd0\"), Slack (\"T123456\").",
+"type": "string"
+},
+"uri": {
+"description": "The URI of the tenant, if applicable. For example, the URI of a Jira instance is https://my-jira-instance.atlassian.net, and a Slack tenant does not have a URI.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": {
 "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata",
@@ -13661,6 +14413,10 @@
 "description": "Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. Applicable to only 3P connectors. When the refresh interval is set to the same value as the incremental refresh interval, incremental sync will be disabled, i.e. set to true.",
 "type": "boolean"
 },
+"jsonParams": {
+"description": "Required data connector parameters in json string format.",
+"type": "string"
+},
 "kmsKeyName": {
 "description": "Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key.",
 "type": "string"
@@ -13691,7 +14447,7 @@
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
+"description": "Required data connector parameters in structured json format.",
 "type": "object"
 },
 "privateConnectivityProjectId": {
@@ -13913,6 +14669,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
 "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
 },
+"jsonParams": {
+"description": "The parameters for the entity to facilitate data ingestion in json string format.",
+"type": "string"
+},
 "keyPropertyMappings": {
 "additionalProperties": {
 "type": "string"
@@ -13925,7 +14685,7 @@
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.",
+"description": "The parameters for the entity to facilitate data ingestion in structured json format.",
 "type": "object"
 },
 "startingSchema": {
@@ -14308,6 +15068,10 @@
 },
 "type": "array"
 },
+"jsonParams": {
+"description": "Additional parameters for this destination config in json string format.",
+"type": "string"
+},
 "key": {
 "description": "Optional. Unique destination identifier that is supported by the connector.",
 "type": "string"
@@ -14317,7 +15081,7 @@
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "Optional. Additional parameters for this destination config.",
+"description": "Optional. Additional parameters for this destination config in structured json format.",
 "type": "object"
 }
 },
@@ -14558,6 +15322,18 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig",
 "description": "Common config spec that specifies the metadata of the engine."
 },
+"configurableBillingApproach": {
+"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.",
+"enum": [
+"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
+"CONFIGURABLE_BILLING_APPROACH_ENABLED"
+],
+"enumDescriptions": [
+"Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.",
+"The billing approach follows configurations specified by customer."
+],
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp the Recommendation Engine was created at.",
 "format": "google-datetime",
@@ -14593,7 +15369,7 @@
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`",
 "type": "object"
 },
 "industryVertical": {
@@ -15779,6 +16555,10 @@
 "readOnly": true,
 "type": "string"
 },
+"customerProvidedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig",
+"description": "Optional. Customer provided configurations."
+},
 "name": {
 "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
 "readOnly": true,
@@ -15801,6 +16581,43 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig": {
+"description": "Customer provided configurations.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfig",
+"properties": {
+"notebooklmConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig",
+"description": "Optional. Configuration for NotebookLM settings."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig": {
+"description": "Configuration for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig",
+"properties": {
+"modelArmorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
+"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
+"id": "GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"properties": {
+"responseTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.",
+"type": "string"
+},
+"userPromptTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": {
 "description": "Metadata about the terms of service.",
 "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms",
@@ -16467,7 +17284,7 @@
 "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
 },
 "offset": {
-"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
 "format": "int32",
 "type": "integer"
 },
@@ -16567,6 +17384,10 @@ false
 "description": "Whether to turn on safe search. This is only supported for website search.",
 "type": "boolean"
 },
+"searchAddonSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec",
+"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests."
+},
 "searchAsYouTypeSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
 "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
@@ -17073,6 +17894,13 @@ false
 "description": "Specification to enable natural language understanding capabilities for search requests.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
 "properties": {
+"allowedFieldNames": {
+"description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "extractedFilterBehavior": {
 "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.",
 "enum": [
@@ -17168,6 +17996,25 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec": {
+"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAddonSpec",
+"properties": {
+"disableGenerativeAnswerAddOn": {
+"description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.",
+"type": "boolean"
+},
+"disableKpiPersonalizationAddOn": {
+"description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.",
+"type": "boolean"
+},
+"disableSemanticAddOn": {
+"description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": {
 "description": "Specification for search as you type in search requests.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
@@ -19979,6 +20826,10 @@ false
 "description": "Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site.",
 "type": "string"
 },
+"mimeType": {
+"description": "The mime type of the document. https://www.iana.org/assignments/media-types/media-types.xhtml.",
+"type": "string"
+},
 "pageIdentifier": {
 "description": "Page identifier.",
 "type": "string"
@@ -22351,6 +23202,18 @@ false
 "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig",
 "description": "Common config spec that specifies the metadata of the engine."
 },
+"configurableBillingApproach": {
+"description": "Optional. Configuration for configurable billing approach. See go/vais-repricing-billing-dd for more details.",
+"enum": [
+"CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED",
+"CONFIGURABLE_BILLING_APPROACH_ENABLED"
+],
+"enumDescriptions": [
+"Default value. For Spark and non-Spark non-configurable billing approach. General pricing model.",
+"The billing approach follows configurations specified by customer."
+],
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp the Recommendation Engine was created at.",
 "format": "google-datetime",
@@ -22386,7 +23249,7 @@ false
 ],
 "type": "string"
 },
-"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences.",
+"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-image-generation` * `disable-video-generation`",
 "type": "object"
 },
 "industryVertical": {
@@ -24111,6 +24974,10 @@ false
 "readOnly": true,
 "type": "string"
 },
+"customerProvidedConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig",
+"description": "Optional. Customer provided configurations."
+},
 "name": {
 "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
 "readOnly": true,
@@ -24133,6 +25000,43 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig": {
+"description": "Customer provided configurations.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfig",
+"properties": {
+"notebooklmConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig",
+"description": "Optional. Configuration for NotebookLM settings."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig": {
+"description": "Configuration for NotebookLM.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig",
+"properties": {
+"modelArmorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"description": "Model Armor configuration to be used for sanitizing user prompts and LLM responses."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig": {
+"description": "Configuration for customer defined Model Armor templates to be used for sanitizing user prompts and LLM responses.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig",
+"properties": {
+"responseTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing LLM responses. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the LLM response.",
+"type": "string"
+},
+"userPromptTemplate": {
+"description": "Optional. The resource name of the Model Armor Template for sanitizing user prompts. Format: projects/{project}/locations/{location}/templates/{template_id} If not specified, no sanitization will be applied to the user prompt.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": {
 "description": "Metadata about the terms of service.",
 "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms",
@@ -24206,6 +25110,10 @@ false
 "acceptBizQos": {
 "description": "Optional. Set to `true` to specify that caller has read and would like to give consent to the [Terms for Agent Space quality of service].",
 "type": "boolean"
+},
+"isBiz": {
+"description": "Optional. Indicates if the current request is for Biz edition (= true) or not (= false).",
+"type": "boolean"
 }
 },
 "type": "object"
@@ -25110,7 +26018,7 @@ false
 "description": "Config for natural language query understanding capabilities, such as extracting structured field filters from the query. Refer to [this documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries) for more information. If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
 },
 "offset": {
-"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. A large offset may be capped to a reasonable threshold.",
 "format": "int32",
 "type": "integer"
 },
@@ -25210,6 +26118,10 @@ false
 "description": "Whether to turn on safe search. This is only supported for website search.",
 "type": "boolean"
 },
+"searchAddonSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec",
+"description": "Optional. SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. This field is only supported for search requests."
+},
 "searchAsYouTypeSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
 "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
@@ -25712,6 +26624,13 @@ false
 "description": "Specification to enable natural language understanding capabilities for search requests.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
 "properties": {
+"allowedFieldNames": {
+"description": "Optional. Allowlist of fields that can be used for natural language filter extraction. By default, if this is unspecified, all indexable fields are eligible for natural language filter extraction (but are not guaranteed to be used). If any fields are specified in allowed_field_names, only the fields that are both marked as indexable in the schema and specified in the allowlist will be eligible for natural language filter extraction. Note: for multi-datastore search, this is not yet supported, and will be ignored.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "extractedFilterBehavior": {
 "description": "Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.",
 "enum": [
@@ -25807,6 +26726,25 @@ false
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec": {
+"description": "SearchAddonSpec is used to disable add-ons for search as per new repricing model. Refer go/vais-repricing-prd. By default if the SearchAddonSpec is not specified, we consider that the customer wants to enable them wherever applicable.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAddonSpec",
+"properties": {
+"disableGenerativeAnswerAddOn": {
+"description": "Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers.",
+"type": "boolean"
+},
+"disableKpiPersonalizationAddOn": {
+"description": "Optional. If true, disables event re-ranking and personalization to optimize KPIs & personalize results.",
+"type": "boolean"
+},
+"disableSemanticAddOn": {
+"description": "Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": {
 "description": "Specification for search as you type in search requests.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",

From 888f7b33f791fa9fe02bfea06a0704b017eec684 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:08 +0000
Subject: [PATCH 13/26] feat(dlp): update the api

#### dlp:v2

The following keys were added:
- schemas.GooglePrivacyDlpV2OutputStorageConfig.properties.storagePath.$ref (Total Keys: 1)
- schemas.GooglePrivacyDlpV2TagFilter (Total Keys: 8)
---
 ...anizations.locations.discoveryConfigs.html | 48 +++++++++++++++++++
 ...lp_v2.organizations.locations.dlpJobs.html |  6 +++
 ...tions.locations.fileStoreDataProfiles.html | 16 +++++++
 ...2.organizations.locations.jobTriggers.html | 18 +++++++
 ...nizations.locations.tableDataProfiles.html | 16 +++++++
 docs/dyn/dlp_v2.projects.dlpJobs.html         | 24 ++++++++++
 docs/dyn/dlp_v2.projects.jobTriggers.html     | 24 ++++++++++
 ...2.projects.locations.discoveryConfigs.html | 48 +++++++++++++++++++
 .../dlp_v2.projects.locations.dlpJobs.html    | 24 ++++++++++
 ...jects.locations.fileStoreDataProfiles.html | 16 +++++++
 ...dlp_v2.projects.locations.jobTriggers.html | 24 ++++++++++
 ....projects.locations.tableDataProfiles.html | 16 +++++++
 .../discovery_cache/documents/dlp.v2.json     | 39 ++++++++++++++-
 13 files changed, 318 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html
index eccaefbaf32..836e8eb33fc 100644
--- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html
+++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html
@@ -354,6 +354,14 @@ 
Method Details

                   },
                 ],
               },
+              "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                  { # A single tag to filter against.
+                    "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                    "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                  },
+                ],
+              },
             },
             "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
             },
@@ -703,6 +711,14 @@ 
Method Details

                 },
               ],
             },
+            "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+              "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                { # A single tag to filter against.
+                  "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                  "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                },
+              ],
+            },
           },
           "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
           },
@@ -1076,6 +1092,14 @@ 
Method Details

                 },
               ],
             },
+            "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+              "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                { # A single tag to filter against.
+                  "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                  "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                },
+              ],
+            },
           },
           "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
           },
@@ -1436,6 +1460,14 @@ 
Method Details

                     },
                   ],
                 },
+                "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                  "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                    { # A single tag to filter against.
+                      "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                      "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                    },
+                  ],
+                },
               },
               "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
               },
@@ -1804,6 +1836,14 @@ 
Method Details

                   },
                 ],
               },
+              "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                  { # A single tag to filter against.
+                    "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                    "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                  },
+                ],
+              },
             },
             "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
             },
@@ -2154,6 +2194,14 @@ 
Method Details

                 },
               ],
             },
+            "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+              "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                { # A single tag to filter against.
+                  "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                  "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                },
+              ],
+            },
           },
           "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
           },
diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html
index 5c7295d4623..7550f20c69e 100644
--- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html
+++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html
@@ -2771,6 +2771,9 @@ 
Method Details

                 "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
                   "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                     "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                    "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                      "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                    },
                     "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                       "datasetId": "A String", # Dataset ID of the table.
                       "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -3554,6 +3557,9 @@ 
Method Details

                 "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
                   "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                     "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                    "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                      "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                    },
                     "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                       "datasetId": "A String", # Dataset ID of the table.
                       "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html
index a4310a3a832..06d00627c84 100644
--- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html
+++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html
@@ -442,6 +442,14 @@ 
Method Details

                     },
                   ],
                 },
+                "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                  "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                    { # A single tag to filter against.
+                      "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                      "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                    },
+                  ],
+                },
               },
               "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
               },
@@ -1207,6 +1215,14 @@ 
Method Details

                         },
                       ],
                     },
+                    "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                      "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                        { # A single tag to filter against.
+                          "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                          "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                        },
+                      ],
+                    },
                   },
                   "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
                   },
diff --git a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html
index 4c6200e989f..602e6809db7 100644
--- a/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html
+++ b/docs/dyn/dlp_v2.organizations.locations.jobTriggers.html
@@ -167,6 +167,9 @@ 
Method Details

           "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
             "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
               "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+              "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+              },
               "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                 "datasetId": "A String", # Dataset ID of the table.
                 "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -519,6 +522,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -893,6 +899,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -1261,6 +1270,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -1630,6 +1642,9 @@ 
Method Details

           "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
             "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
               "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+              "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+              },
               "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                 "datasetId": "A String", # Dataset ID of the table.
                 "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -1981,6 +1996,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html
index 4dd34993d2a..2353e04b5f8 100644
--- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html
+++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html
@@ -442,6 +442,14 @@ 
Method Details

                     },
                   ],
                 },
+                "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                  "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                    { # A single tag to filter against.
+                      "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                      "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                    },
+                  ],
+                },
               },
               "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
               },
@@ -1151,6 +1159,14 @@ 
Method Details

                         },
                       ],
                     },
+                    "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                      "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                        { # A single tag to filter against.
+                          "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                          "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                        },
+                      ],
+                    },
                   },
                   "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
                   },
diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html
index e94735bed0a..d6cdab27328 100644
--- a/docs/dyn/dlp_v2.projects.dlpJobs.html
+++ b/docs/dyn/dlp_v2.projects.dlpJobs.html
@@ -170,6 +170,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -477,6 +480,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -3272,6 +3278,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -4055,6 +4064,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -6999,6 +7011,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -7782,6 +7797,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -10720,6 +10738,9 @@ 
Method Details

                 "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
                   "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                     "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                    "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                      "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                    },
                     "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                       "datasetId": "A String", # Dataset ID of the table.
                       "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -11503,6 +11524,9 @@ 
Method Details

                 "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
                   "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                     "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                    "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                      "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                    },
                     "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                       "datasetId": "A String", # Dataset ID of the table.
                       "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html
index f85e2abec34..424725a5c8d 100644
--- a/docs/dyn/dlp_v2.projects.jobTriggers.html
+++ b/docs/dyn/dlp_v2.projects.jobTriggers.html
@@ -2775,6 +2775,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -3558,6 +3561,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -3885,6 +3891,9 @@ 
Method Details

           "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
             "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
               "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+              "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+              },
               "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                 "datasetId": "A String", # Dataset ID of the table.
                 "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -4237,6 +4246,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -4611,6 +4623,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -4979,6 +4994,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -5348,6 +5366,9 @@ 
Method Details

           "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
             "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
               "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+              "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+              },
               "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                 "datasetId": "A String", # Dataset ID of the table.
                 "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -5699,6 +5720,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html
index 07719b030e0..1db74f4af1d 100644
--- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html
+++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html
@@ -354,6 +354,14 @@ 
Method Details

                   },
                 ],
               },
+              "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                  { # A single tag to filter against.
+                    "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                    "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                  },
+                ],
+              },
             },
             "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
             },
@@ -703,6 +711,14 @@ 
Method Details

                 },
               ],
             },
+            "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+              "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                { # A single tag to filter against.
+                  "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                  "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                },
+              ],
+            },
           },
           "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
           },
@@ -1076,6 +1092,14 @@ 
Method Details

                 },
               ],
             },
+            "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+              "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                { # A single tag to filter against.
+                  "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                  "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                },
+              ],
+            },
           },
           "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
           },
@@ -1436,6 +1460,14 @@ 
Method Details

                     },
                   ],
                 },
+                "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                  "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                    { # A single tag to filter against.
+                      "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                      "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                    },
+                  ],
+                },
               },
               "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
               },
@@ -1804,6 +1836,14 @@ 
Method Details

                   },
                 ],
               },
+              "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                  { # A single tag to filter against.
+                    "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                    "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                  },
+                ],
+              },
             },
             "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
             },
@@ -2154,6 +2194,14 @@ 
Method Details

                 },
               ],
             },
+            "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+              "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                { # A single tag to filter against.
+                  "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                  "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                },
+              ],
+            },
           },
           "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
           },
diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html
index 91cacb73f6a..ba66f9c20c4 100644
--- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html
+++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html
@@ -176,6 +176,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -483,6 +486,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -3278,6 +3284,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -4061,6 +4070,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -7029,6 +7041,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -7812,6 +7827,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -10838,6 +10856,9 @@ 
Method Details

                 "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
                   "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                     "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                    "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                      "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                    },
                     "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                       "datasetId": "A String", # Dataset ID of the table.
                       "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -11621,6 +11642,9 @@ 
Method Details

                 "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
                   "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                     "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                    "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                      "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                    },
                     "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                       "datasetId": "A String", # Dataset ID of the table.
                       "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html
index 06edbbc5219..09447f8fe99 100644
--- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html
+++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html
@@ -442,6 +442,14 @@ 
Method Details

                     },
                   ],
                 },
+                "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                  "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                    { # A single tag to filter against.
+                      "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                      "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                    },
+                  ],
+                },
               },
               "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
               },
@@ -1207,6 +1215,14 @@ 
Method Details

                         },
                       ],
                     },
+                    "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                      "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                        { # A single tag to filter against.
+                          "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                          "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                        },
+                      ],
+                    },
                   },
                   "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
                   },
diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
index 0c9e8c75dec..e1f62881aa4 100644
--- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
+++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html
@@ -2778,6 +2778,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -3561,6 +3564,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -3888,6 +3894,9 @@ 
Method Details

           "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
             "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
               "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+              "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+              },
               "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                 "datasetId": "A String", # Dataset ID of the table.
                 "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -4240,6 +4249,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -4614,6 +4626,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -5070,6 +5085,9 @@ 
Method Details

             "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
               "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
                 "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+                "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                  "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+                },
                 "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                   "datasetId": "A String", # Dataset ID of the table.
                   "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -5439,6 +5457,9 @@ 
Method Details

           "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
             "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
               "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+              "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+                "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+              },
               "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
                 "datasetId": "A String", # Dataset ID of the table.
                 "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
@@ -5790,6 +5811,9 @@ 
Method Details

         "saveFindings": { # If set, the detailed findings will be persisted to the specified OutputStorageConfig. Only a single instance of this action can be specified. Compatible with: Inspect, Risk # Save resulting findings in a provided location.
           "outputConfig": { # Cloud repository for storing output. # Location to store findings outside of DLP.
             "outputSchema": "A String", # Schema used for writing the findings for Inspect jobs. This field is only used for Inspect and must be unspecified for Risk jobs. Columns are derived from the `Finding` object. If appending to an existing table, any columns from the predefined schema that are missing will be added. No columns in the existing table will be deleted. If unspecified, then all available columns will be used for a new table or an (existing) table with no schema, and no changes will be made to an existing table that has a schema. Only for use with external storage.
+            "storagePath": { # Message representing a single file or path in Cloud Storage. # Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored.
+              "path": "A String", # A URL representing a file or path (no wildcards) in Cloud Storage. Example: `gs://[BUCKET_NAME]/dictionary.txt`
+            },
             "table": { # Message defining the location of a BigQuery table. A table is uniquely identified by its project_id, dataset_id, and table_name. Within a query a table is often referenced with a string in the format of: `:.` or `..`. # Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table.
               "datasetId": "A String", # Dataset ID of the table.
               "projectId": "A String", # The Google Cloud project ID of the project containing the table. If omitted, project ID is inferred from the API call.
diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html
index d4e6aab8eee..ae6aa990030 100644
--- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html
+++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html
@@ -442,6 +442,14 @@ 
Method Details

                     },
                   ],
                 },
+                "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                  "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                    { # A single tag to filter against.
+                      "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                      "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                    },
+                  ],
+                },
               },
               "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
               },
@@ -1151,6 +1159,14 @@ 
Method Details

                         },
                       ],
                     },
+                    "includeTags": { # Tags to match against for filtering. # Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more.
+                      "tagFilters": [ # Required. A resource must match ALL of the specified tag filters to be included in the collection.
+                        { # A single tag to filter against.
+                          "namespacedTagKey": "A String", # The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, "123456/sensitive" for an organization parent, or "my-project/sensitive" for a project parent.
+                          "namespacedTagValue": "A String", # The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, "123456/environment/prod" for an organization parent, or "my-project/environment/prod" for a project parent.
+                        },
+                      ],
+                    },
                   },
                   "others": { # Match discovery resources not covered by any other filter. # Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically.
                   },
diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json
index afd6e2ead6a..b79ec21a1a6 100644
--- a/googleapiclient/discovery_cache/documents/dlp.v2.json
+++ b/googleapiclient/discovery_cache/documents/dlp.v2.json
@@ -5123,7 +5123,7 @@
 }
 }
 },
-"revision": "20250824",
+"revision": "20250914",
 "rootUrl": "https://dlp.googleapis.com/",
 "schemas": {
 "GooglePrivacyDlpV2Action": {
@@ -8657,6 +8657,10 @@
 "includeRegexes": {
 "$ref": "GooglePrivacyDlpV2FileStoreRegexes",
 "description": "Optional. A collection of regular expressions to match a file store against."
+},
+"includeTags": {
+"$ref": "GooglePrivacyDlpV2TagFilters",
+"description": "Optional. To be included in the collection, a resource must meet all of the following requirements: - If tag filters are provided, match all provided tag filters. - If one or more patterns are specified, match at least one pattern. For a resource to match the tag filters, the resource must have all of the provided tags attached. Tags refer to Resource Manager tags bound to the resource or its ancestors. See https://cloud.google.com/sensitive-data-protection/docs/profile-project-cloud-storage#manage-schedules to learn more."
 }
 },
 "type": "object"
@@ -10800,6 +10804,10 @@
 ],
 "type": "string"
 },
+"storagePath": {
+"$ref": "GooglePrivacyDlpV2CloudStoragePath",
+"description": "Store findings in an existing Cloud Storage bucket. Files will be generated with the job ID and file part number as the filename, and will contain findings in textproto format as SaveToGcsFindingsOutput. The file name will use the naming convention -, for example: my-job-id-2. Supported for Inspect jobs. The bucket must not be the same as the bucket being inspected. If storing findings to Cloud Storage, the output schema field should not be set. If set, it will be ignored."
+},
 "table": {
 "$ref": "GooglePrivacyDlpV2BigQueryTable",
 "description": "Store findings in an existing table or a new table in an existing dataset. If table_id is not set a new one will be generated for you with the following format: dlp_googleapis_yyyy_mm_dd_[dlp_job_id]. Pacific time zone will be used for generating the date details. For Inspect, each column in an existing output table must have the same name, type, and mode of a field in the `Finding` object. For Risk, an existing output table should be the output of a previous Risk analysis job run on the same source table, with the same privacy metric and quasi-identifiers. Risk jobs that analyze the same table but compute a different privacy metric, or use different sets of quasi-identifiers, cannot store their results in the same table."
@@ -12298,6 +12306,35 @@
 },
 "type": "object"
 },
+"GooglePrivacyDlpV2TagFilter": {
+"description": "A single tag to filter against.",
+"id": "GooglePrivacyDlpV2TagFilter",
+"properties": {
+"namespacedTagKey": {
+"description": "The namespaced name for the tag key. Must be in the format `{parent_id}/{tag_key_short_name}`, for example, \"123456/sensitive\" for an organization parent, or \"my-project/sensitive\" for a project parent.",
+"type": "string"
+},
+"namespacedTagValue": {
+"description": "The namespaced name for the tag value. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\" for an organization parent, or \"my-project/environment/prod\" for a project parent.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GooglePrivacyDlpV2TagFilters": {
+"description": "Tags to match against for filtering.",
+"id": "GooglePrivacyDlpV2TagFilters",
+"properties": {
+"tagFilters": {
+"description": "Required. A resource must match ALL of the specified tag filters to be included in the collection.",
+"items": {
+"$ref": "GooglePrivacyDlpV2TagFilter"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GooglePrivacyDlpV2TagResources": {
 "description": "If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag.",
 "id": "GooglePrivacyDlpV2TagResources",

From 50eb5b6bd4e83df7ecacbfc5cbc2cd7d1db58773 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:08 +0000
Subject: [PATCH 14/26] feat(documentai): update the api

#### documentai:v1

The following keys were added:
- schemas.GoogleCloudDocumentaiV1Processor.properties.activeSchemaVersion.type (Total Keys: 1)

#### documentai:v1beta3

The following keys were added:
- schemas.GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock.properties.annotations.$ref (Total Keys: 1)
- schemas.GoogleCloudDocumentaiV1beta3Processor.properties.activeSchemaVersion.type (Total Keys: 1)
---
 ...ocumentai_v1.projects.locations.processors.html |  4 ++++
 ...cts.locations.processors.processorVersions.html |  2 +-
 ...eta3.projects.locations.processors.dataset.html |  3 +++
 ...ntai_v1beta3.projects.locations.processors.html | 13 +++++++++++++
 ...cts.locations.processors.humanReviewConfig.html |  6 ++++++
 ...cts.locations.processors.processorVersions.html | 13 +++++++++++--
 .../discovery_cache/documents/documentai.v1.json   |  8 ++++++--
 .../documents/documentai.v1beta3.json              | 14 +++++++++++---
 8 files changed, 55 insertions(+), 8 deletions(-)

diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html
index 9a1ffd8a704..d9cd53f11f2 100644
--- a/docs/dyn/documentai_v1.projects.locations.processors.html
+++ b/docs/dyn/documentai_v1.projects.locations.processors.html
@@ -271,6 +271,7 @@ 
Method Details

     The object takes the form of:
 
 { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
+  "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}
   "createTime": "A String", # Output only. The time the processor was created.
   "defaultProcessorVersion": "A String", # The default processor version.
   "displayName": "A String", # The display name of the processor.
@@ -298,6 +299,7 @@ 
Method Details

   An object of the form:
 
     { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
+  "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}
   "createTime": "A String", # Output only. The time the processor was created.
   "defaultProcessorVersion": "A String", # The default processor version.
   "displayName": "A String", # The display name of the processor.
@@ -449,6 +451,7 @@ 
Method Details

   An object of the form:
 
     { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
+  "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}
   "createTime": "A String", # Output only. The time the processor was created.
   "defaultProcessorVersion": "A String", # The default processor version.
   "displayName": "A String", # The display name of the processor.
@@ -488,6 +491,7 @@ 
Method Details

   "nextPageToken": "A String", # Points to the next processor, otherwise empty.
   "processors": [ # The list of processors.
     { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
+      "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}
       "createTime": "A String", # Output only. The time the processor was created.
       "defaultProcessorVersion": "A String", # The default processor version.
       "displayName": "A String", # The display name of the processor.
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
index a20c234dbf2..c27d8386b30 100644
--- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
+++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
@@ -2649,7 +2649,7 @@ 
Method Details

 { # Request message for the TrainProcessorVersion method.
   "baseProcessorVersion": "A String", # Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
   "customDocumentExtractionOptions": { # Options to control the training of the Custom Document Extraction (CDE) Processor. # Options to control Custom Document Extraction (CDE) Processor.
-    "trainingMethod": "A String", # Training method to use for CDE training.
+    "trainingMethod": "A String", # Optional. Training method to use for CDE training.
   },
   "documentSchema": { # The schema defines the output of the processed document by a processor. # Optional. The schema the processor version will be trained with.
     "description": "A String", # Description of the schema.
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html
index 7c11b42189f..2f21d5ac355 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html
@@ -399,6 +399,9 @@ 
Method Details

             ],
           },
           "textBlock": { # Represents a text type block. # Block consisting of text content.
+            "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the text block.
+              "description": "A String", # The description of the content with this annotation.
+            },
             "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
               # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
             ],
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html
index e193bcfaaf0..d37c1d8e616 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html
@@ -308,6 +308,7 @@ 
Method Details

     The object takes the form of:
 
 { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
+  "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}
   "createTime": "A String", # Output only. The time the processor was created.
   "defaultProcessorVersion": "A String", # The default processor version.
   "displayName": "A String", # The display name of the processor.
@@ -335,6 +336,7 @@ 
Method Details

   An object of the form:
 
     { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
+  "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}
   "createTime": "A String", # Output only. The time the processor was created.
   "defaultProcessorVersion": "A String", # The default processor version.
   "displayName": "A String", # The display name of the processor.
@@ -486,6 +488,7 @@ 
Method Details

   An object of the form:
 
     { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
+  "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}
   "createTime": "A String", # Output only. The time the processor was created.
   "defaultProcessorVersion": "A String", # The default processor version.
   "displayName": "A String", # The display name of the processor.
@@ -525,6 +528,7 @@ 
Method Details

   "nextPageToken": "A String", # Points to the next processor, otherwise empty.
   "processors": [ # The list of processors.
     { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.
+      "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}
       "createTime": "A String", # Output only. The time the processor was created.
       "defaultProcessorVersion": "A String", # The default processor version.
       "displayName": "A String", # The display name of the processor.
@@ -705,6 +709,9 @@ 
Method Details

             ],
           },
           "textBlock": { # Represents a text type block. # Block consisting of text content.
+            "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the text block.
+              "description": "A String", # The description of the content with this annotation.
+            },
             "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
               # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
             ],
@@ -1701,6 +1708,9 @@ 
Method Details

             ],
           },
           "textBlock": { # Represents a text type block. # Block consisting of text content.
+            "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the text block.
+              "description": "A String", # The description of the content with this annotation.
+            },
             "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
               # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
             ],
@@ -2801,6 +2811,9 @@ 
Method Details

             ],
           },
           "textBlock": { # Represents a text type block. # Block consisting of text content.
+            "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the text block.
+              "description": "A String", # The description of the content with this annotation.
+            },
             "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
               # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
             ],
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html
index 4a8854222f1..3f43b1b6bac 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html
@@ -231,6 +231,9 @@ 
Method Details

             ],
           },
           "textBlock": { # Represents a text type block. # Block consisting of text content.
+            "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the text block.
+              "description": "A String", # The description of the content with this annotation.
+            },
             "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
               # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
             ],
@@ -1269,6 +1272,9 @@ 
Method Details

             ],
           },
           "textBlock": { # Represents a text type block. # Block consisting of text content.
+            "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the text block.
+              "description": "A String", # The description of the content with this annotation.
+            },
             "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
               # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
             ],
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html
index 9fa7c5078bd..91f499b786f 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html
@@ -551,7 +551,7 @@ 
Method Details

     "processorVersion": "A String", # Required. The processor version name. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
     "serviceEndpoint": "A String", # Optional. The Document AI service endpoint. For example, 'https://us-documentai.googleapis.com'
   },
-  "processorVersionSource": "A String", # The source processor version to import from. The source processor version and destination processor need to be in the same environment and region. Note that ProcessorVersions with `model_type` `MODEL_TYPE_LLM` are not supported.
+  "processorVersionSource": "A String", # The source processor version to import from. The source processor version and destination processor need to be in the same environment and region.
 }
 
   x__xgafv: string, V1 error format.
@@ -868,6 +868,9 @@ 
Method Details

             ],
           },
           "textBlock": { # Represents a text type block. # Block consisting of text content.
+            "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the text block.
+              "description": "A String", # The description of the content with this annotation.
+            },
             "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
               # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
             ],
@@ -1864,6 +1867,9 @@ 
Method Details

             ],
           },
           "textBlock": { # Represents a text type block. # Block consisting of text content.
+            "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the text block.
+              "description": "A String", # The description of the content with this annotation.
+            },
             "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
               # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
             ],
@@ -2964,6 +2970,9 @@ 
Method Details

             ],
           },
           "textBlock": { # Represents a text type block. # Block consisting of text content.
+            "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the text block.
+              "description": "A String", # The description of the content with this annotation.
+            },
             "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.
               # Object with schema name: GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlock
             ],
@@ -3840,7 +3849,7 @@ 
Method Details

 { # Request message for the TrainProcessorVersion method.
   "baseProcessorVersion": "A String", # Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.
   "customDocumentExtractionOptions": { # Options to control the training of the Custom Document Extraction (CDE) Processor. # Options to control Custom Document Extraction (CDE) Processor.
-    "trainingMethod": "A String", # Training method to use for CDE training.
+    "trainingMethod": "A String", # Optional. Training method to use for CDE training.
   },
   "documentSchema": { # The schema defines the output of the processed document by a processor. # Optional. The schema the processor version will be trained with.
     "description": "A String", # Description of the schema.
diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json
index 2ddd33f860d..7a7ab9b5e1e 100644
--- a/googleapiclient/discovery_cache/documents/documentai.v1.json
+++ b/googleapiclient/discovery_cache/documents/documentai.v1.json
@@ -1048,7 +1048,7 @@
 }
 }
 },
-"revision": "20250908",
+"revision": "20250914",
 "rootUrl": "https://documentai.googleapis.com/",
 "schemas": {
 "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": {
@@ -4754,6 +4754,10 @@ true
 "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.",
 "id": "GoogleCloudDocumentaiV1Processor",
 "properties": {
+"activeSchemaVersion": {
+"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
+"type": "string"
+},
 "createTime": {
 "description": "Output only. The time the processor was created.",
 "format": "google-datetime",
@@ -5308,7 +5312,7 @@ true
 "id": "GoogleCloudDocumentaiV1TrainProcessorVersionRequestCustomDocumentExtractionOptions",
 "properties": {
 "trainingMethod": {
-"description": "Training method to use for CDE training.",
+"description": "Optional. Training method to use for CDE training.",
 "enum": [
 "TRAINING_METHOD_UNSPECIFIED",
 "MODEL_BASED",
diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json
index 1c6eb0ced37..df8ca606c19 100644
--- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json
+++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json
@@ -1290,7 +1290,7 @@
 }
 }
 },
-"revision": "20250908",
+"revision": "20250914",
 "rootUrl": "https://documentai.googleapis.com/",
 "schemas": {
 "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": {
@@ -3767,6 +3767,10 @@
 "description": "Represents a text type block.",
 "id": "GoogleCloudDocumentaiV1beta3DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock",
 "properties": {
+"annotations": {
+"$ref": "GoogleCloudDocumentaiV1beta3DocumentAnnotations",
+"description": "Annotation of the text block."
+},
 "blocks": {
 "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.",
 "items": {
@@ -5753,7 +5757,7 @@ true
 "description": "The source processor version to import from. It can be from a different environment and region than the destination processor."
 },
 "processorVersionSource": {
-"description": "The source processor version to import from. The source processor version and destination processor need to be in the same environment and region. Note that ProcessorVersions with `model_type` `MODEL_TYPE_LLM` are not supported.",
+"description": "The source processor version to import from. The source processor version and destination processor need to be in the same environment and region.",
 "type": "string"
 }
 },
@@ -6180,6 +6184,10 @@ true
 "description": "The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.",
 "id": "GoogleCloudDocumentaiV1beta3Processor",
 "properties": {
+"activeSchemaVersion": {
+"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
+"type": "string"
+},
 "createTime": {
 "description": "Output only. The time the processor was created.",
 "format": "google-datetime",
@@ -6856,7 +6864,7 @@ true
 "id": "GoogleCloudDocumentaiV1beta3TrainProcessorVersionRequestCustomDocumentExtractionOptions",
 "properties": {
 "trainingMethod": {
-"description": "Training method to use for CDE training.",
+"description": "Optional. Training method to use for CDE training.",
 "enum": [
 "TRAINING_METHOD_UNSPECIFIED",
 "MODEL_BASED",

From b3ab658cc884f18e940e83cfa6844227bedc9eba Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:08 +0000
Subject: [PATCH 15/26] feat(domains): update the api

#### domains:v1

The following keys were added:
- resources.projects.resources.locations.methods.list.parameters.extraLocationTypes (Total Keys: 3)

#### domains:v1alpha2

The following keys were added:
- resources.projects.resources.locations.methods.list.parameters.extraLocationTypes (Total Keys: 3)

#### domains:v1beta1

The following keys were added:
- resources.projects.resources.locations.methods.list.parameters.extraLocationTypes (Total Keys: 3)
---
 docs/dyn/domains_v1.projects.locations.html   |   5 +-
 ...s_v1.projects.locations.registrations.html | 462 +++++++++---------
 .../domains_v1alpha2.projects.locations.html  |   5 +-
 ...pha2.projects.locations.registrations.html | 462 +++++++++---------
 .../domains_v1beta1.projects.locations.html   |   5 +-
 ...eta1.projects.locations.registrations.html | 462 +++++++++---------
 .../discovery_cache/documents/domains.v1.json |  28 +-
 .../documents/domains.v1alpha2.json           |  28 +-
 .../documents/domains.v1beta1.json            |  28 +-
 9 files changed, 756 insertions(+), 729 deletions(-)

diff --git a/docs/dyn/domains_v1.projects.locations.html b/docs/dyn/domains_v1.projects.locations.html
index 28d71dc9cb7..017b4642a66 100644
--- a/docs/dyn/domains_v1.projects.locations.html
+++ b/docs/dyn/domains_v1.projects.locations.html
@@ -91,7 +91,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
Gets information about a location.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

 
Lists information about the supported locations for this service.

 

   list_next()

@@ -130,11 +130,12 @@ 
Method Details

 

 
 

-    list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+    list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
   
Lists information about the supported locations for this service.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/domains_v1.projects.locations.registrations.html b/docs/dyn/domains_v1.projects.locations.registrations.html
index b7c80123924..ec3208b19b7 100644
--- a/docs/dyn/domains_v1.projects.locations.registrations.html
+++ b/docs/dyn/domains_v1.projects.locations.registrations.html
@@ -182,22 +182,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -205,44 +205,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -507,22 +507,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -530,44 +530,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -636,22 +636,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -659,44 +659,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -870,22 +870,22 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -893,44 +893,44 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
       },
@@ -999,22 +999,22 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1022,44 +1022,44 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
       },
@@ -1103,22 +1103,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1126,44 +1126,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -1232,22 +1232,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1255,44 +1255,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -1356,22 +1356,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1379,44 +1379,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
@@ -1485,22 +1485,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1508,44 +1508,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
@@ -2225,22 +2225,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -2248,44 +2248,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
@@ -2354,22 +2354,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -2377,44 +2377,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
diff --git a/docs/dyn/domains_v1alpha2.projects.locations.html b/docs/dyn/domains_v1alpha2.projects.locations.html
index 6a29e6fd99a..3d6b3e8699f 100644
--- a/docs/dyn/domains_v1alpha2.projects.locations.html
+++ b/docs/dyn/domains_v1alpha2.projects.locations.html
@@ -91,7 +91,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
Gets information about a location.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

 
Lists information about the supported locations for this service.

 

   list_next()

@@ -130,11 +130,12 @@ 
Method Details

 

 
 

-    list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+    list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
   
Lists information about the supported locations for this service.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/domains_v1alpha2.projects.locations.registrations.html b/docs/dyn/domains_v1alpha2.projects.locations.registrations.html
index fd9390e5eaf..3e585e018c5 100644
--- a/docs/dyn/domains_v1alpha2.projects.locations.registrations.html
+++ b/docs/dyn/domains_v1alpha2.projects.locations.registrations.html
@@ -182,22 +182,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -205,44 +205,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -507,22 +507,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -530,44 +530,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -636,22 +636,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -659,44 +659,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -871,22 +871,22 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -894,44 +894,44 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
       },
@@ -1000,22 +1000,22 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1023,44 +1023,44 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
       },
@@ -1105,22 +1105,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1128,44 +1128,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -1234,22 +1234,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1257,44 +1257,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -1359,22 +1359,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1382,44 +1382,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
@@ -1488,22 +1488,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1511,44 +1511,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
@@ -2229,22 +2229,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -2252,44 +2252,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
@@ -2358,22 +2358,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -2381,44 +2381,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
diff --git a/docs/dyn/domains_v1beta1.projects.locations.html b/docs/dyn/domains_v1beta1.projects.locations.html
index f3c0ba28b7b..b458c23cd4b 100644
--- a/docs/dyn/domains_v1beta1.projects.locations.html
+++ b/docs/dyn/domains_v1beta1.projects.locations.html
@@ -91,7 +91,7 @@ 
Instance Methods

   get(name, x__xgafv=None)

 
Gets information about a location.

 

-  list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+  list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

 
Lists information about the supported locations for this service.

 

   list_next()

@@ -130,11 +130,12 @@ 
Method Details

 

 
 

-    list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+    list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
   
Lists information about the supported locations for this service.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/domains_v1beta1.projects.locations.registrations.html b/docs/dyn/domains_v1beta1.projects.locations.registrations.html
index 0ff317e0d60..f64d84f5755 100644
--- a/docs/dyn/domains_v1beta1.projects.locations.registrations.html
+++ b/docs/dyn/domains_v1beta1.projects.locations.registrations.html
@@ -182,22 +182,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -205,44 +205,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -507,22 +507,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -530,44 +530,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -636,22 +636,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -659,44 +659,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -870,22 +870,22 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -893,44 +893,44 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
       },
@@ -999,22 +999,22 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1022,44 +1022,44 @@ 
Method Details

           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
         "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
           "email": "A String", # Required. Email address of the contact.
           "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
           "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-          "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+            "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
               "A String",
             ],
-            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+            "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
             "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-            "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+            "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
             "organization": "A String", # Optional. The name of the organization at the address.
-            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+            "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
             "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
               "A String",
             ],
             "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
             "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+            "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+            "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
           },
         },
       },
@@ -1103,22 +1103,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1126,44 +1126,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -1232,22 +1232,22 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1255,44 +1255,44 @@ 
Method Details

       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
     "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
       "email": "A String", # Required. Email address of the contact.
       "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
       "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-      "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
           "A String",
         ],
-        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
         "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-        "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
         "organization": "A String", # Optional. The name of the organization at the address.
-        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
         "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
           "A String",
         ],
         "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
         "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
       },
     },
   },
@@ -1356,22 +1356,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1379,44 +1379,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
@@ -1485,22 +1485,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -1508,44 +1508,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
@@ -2225,22 +2225,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -2248,44 +2248,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
@@ -2354,22 +2354,22 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "privacy": "A String", # Required. Privacy setting for the contacts associated with the `Registration`.
@@ -2377,44 +2377,44 @@ 
Method Details

         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
       "technicalContact": { # Details required for a contact associated with a `Registration`. # Required. The technical contact for the `Registration`.
         "email": "A String", # Required. Email address of the contact.
         "faxNumber": "A String", # Fax number of the contact in international format. For example, `"+1-800-555-0123"`.
         "phoneNumber": "A String", # Required. Phone number of the contact in international format. For example, `"+1-800-555-0123"`.
-        "postalAddress": { # Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478 # Required. Postal address of the contact.
-          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "postalAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Required. Postal address of the contact.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
             "A String",
           ],
-          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
           "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-          "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
           "organization": "A String", # Optional. The name of the organization at the address.
-          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
           "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
             "A String",
           ],
           "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
           "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (For example "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (For example Côte d'Ivoire).
-          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
         },
       },
     },
diff --git a/googleapiclient/discovery_cache/documents/domains.v1.json b/googleapiclient/discovery_cache/documents/domains.v1.json
index 2fc4fcbabe5..e6a2651fd79 100644
--- a/googleapiclient/discovery_cache/documents/domains.v1.json
+++ b/googleapiclient/discovery_cache/documents/domains.v1.json
@@ -143,6 +143,12 @@
 "name"
 ],
 "parameters": {
+"extraLocationTypes": {
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
 "filter": {
 "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
@@ -965,7 +971,7 @@
 }
 }
 },
-"revision": "20250225",
+"revision": "20250918",
 "rootUrl": "https://domains.googleapis.com/",
 "schemas": {
 "AuditConfig": {
@@ -1939,18 +1945,18 @@ false
 "type": "object"
 },
 "PostalAddress": {
-"description": "Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478",
+"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.",
 "id": "PostalAddress",
 "properties": {
 "addressLines": {
-"description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
+"description": "Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
 "items": {
 "type": "string"
 },
 "type": "array"
 },
 "administrativeArea": {
-"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.",
+"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.",
 "type": "string"
 },
 "languageCode": {
@@ -1958,7 +1964,7 @@ false
 "type": "string"
 },
 "locality": {
-"description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.",
+"description": "Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.",
 "type": "string"
 },
 "organization": {
@@ -1966,7 +1972,7 @@ false
 "type": "string"
 },
 "postalCode": {
-"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).",
+"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).",
 "type": "string"
 },
 "recipients": {
@@ -1986,11 +1992,11 @@ false
 "type": "integer"
 },
 "sortingCode": {
-"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (For example \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (For example C\u00f4te d'Ivoire).",
+"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (for example, \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (C\u00f4te d'Ivoire).",
 "type": "string"
 },
 "sublocality": {
-"description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.",
+"description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.",
 "type": "string"
 }
 },
@@ -2220,14 +2226,16 @@ false
 "CONTACT_SUPPORT",
 "UNVERIFIED_EMAIL",
 "PROBLEM_WITH_BILLING",
-"DNS_NOT_ACTIVATED"
+"DNS_NOT_ACTIVATED",
+"AUTO_RENEWAL_UPDATE_NOT_EFFECTIVE"
 ],
 "enumDescriptions": [
 "The issue is undefined.",
 "Contact the Cloud Support team to resolve a problem with this domain.",
 "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.",
 "The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account.",
-"The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation."
+"The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation.",
+"Due to SquareSpace's constraints, the auto-renewal update you made may not be effective during a certain period of time. Generally, the time period is 15 days before expiration for generic TLD domains, and 15 days before expiration + 3 days after expiration for country-code TLD domains."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/domains.v1alpha2.json b/googleapiclient/discovery_cache/documents/domains.v1alpha2.json
index fa9a6b62f8b..39c2be96875 100644
--- a/googleapiclient/discovery_cache/documents/domains.v1alpha2.json
+++ b/googleapiclient/discovery_cache/documents/domains.v1alpha2.json
@@ -143,6 +143,12 @@
 "name"
 ],
 "parameters": {
+"extraLocationTypes": {
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
 "filter": {
 "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
@@ -965,7 +971,7 @@
 }
 }
 },
-"revision": "20250225",
+"revision": "20250918",
 "rootUrl": "https://domains.googleapis.com/",
 "schemas": {
 "AuditConfig": {
@@ -1939,18 +1945,18 @@ false
 "type": "object"
 },
 "PostalAddress": {
-"description": "Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478",
+"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.",
 "id": "PostalAddress",
 "properties": {
 "addressLines": {
-"description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
+"description": "Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
 "items": {
 "type": "string"
 },
 "type": "array"
 },
 "administrativeArea": {
-"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.",
+"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.",
 "type": "string"
 },
 "languageCode": {
@@ -1958,7 +1964,7 @@ false
 "type": "string"
 },
 "locality": {
-"description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.",
+"description": "Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.",
 "type": "string"
 },
 "organization": {
@@ -1966,7 +1972,7 @@ false
 "type": "string"
 },
 "postalCode": {
-"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).",
+"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).",
 "type": "string"
 },
 "recipients": {
@@ -1986,11 +1992,11 @@ false
 "type": "integer"
 },
 "sortingCode": {
-"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (For example \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (For example C\u00f4te d'Ivoire).",
+"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (for example, \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (C\u00f4te d'Ivoire).",
 "type": "string"
 },
 "sublocality": {
-"description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.",
+"description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.",
 "type": "string"
 }
 },
@@ -2220,14 +2226,16 @@ false
 "CONTACT_SUPPORT",
 "UNVERIFIED_EMAIL",
 "PROBLEM_WITH_BILLING",
-"DNS_NOT_ACTIVATED"
+"DNS_NOT_ACTIVATED",
+"AUTO_RENEWAL_UPDATE_NOT_EFFECTIVE"
 ],
 "enumDescriptions": [
 "The issue is undefined.",
 "Contact the Cloud Support team to resolve a problem with this domain.",
 "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.",
 "The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account.",
-"The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation."
+"The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation.",
+"Due to SquareSpace's constraints, the auto-renewal update you made may not be effective during a certain period of time. Generally, the time period is 15 days before expiration for generic TLD domains, and 15 days before expiration + 3 days after expiration for country-code TLD domains."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/domains.v1beta1.json b/googleapiclient/discovery_cache/documents/domains.v1beta1.json
index 134b7a45b61..231d9c5a57b 100644
--- a/googleapiclient/discovery_cache/documents/domains.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/domains.v1beta1.json
@@ -143,6 +143,12 @@
 "name"
 ],
 "parameters": {
+"extraLocationTypes": {
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
 "filter": {
 "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
 "location": "query",
@@ -965,7 +971,7 @@
 }
 }
 },
-"revision": "20250225",
+"revision": "20250918",
 "rootUrl": "https://domains.googleapis.com/",
 "schemas": {
 "AuditConfig": {
@@ -1939,18 +1945,18 @@ false
 "type": "object"
 },
 "PostalAddress": {
-"description": "Represents a postal address. For example for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478",
+"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.",
 "id": "PostalAddress",
 "properties": {
 "addressLines": {
-"description": "Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (For example \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country/region of the address. In places where this can vary (For example Japan), address_language is used to make it explicit (For example \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
+"description": "Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).",
 "items": {
 "type": "string"
 },
 "type": "array"
 },
 "administrativeArea": {
-"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (For example \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example in Switzerland this should be left unpopulated.",
+"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.",
 "type": "string"
 },
 "languageCode": {
@@ -1958,7 +1964,7 @@ false
 "type": "string"
 },
 "locality": {
-"description": "Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.",
+"description": "Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.",
 "type": "string"
 },
 "organization": {
@@ -1966,7 +1972,7 @@ false
 "type": "string"
 },
 "postalCode": {
-"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (For example state/zip validation in the U.S.A.).",
+"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).",
 "type": "string"
 },
 "recipients": {
@@ -1986,11 +1992,11 @@ false
 "type": "integer"
 },
 "sortingCode": {
-"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (For example \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (For example C\u00f4te d'Ivoire).",
+"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (for example, \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (C\u00f4te d'Ivoire).",
 "type": "string"
 },
 "sublocality": {
-"description": "Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.",
+"description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.",
 "type": "string"
 }
 },
@@ -2220,14 +2226,16 @@ false
 "CONTACT_SUPPORT",
 "UNVERIFIED_EMAIL",
 "PROBLEM_WITH_BILLING",
-"DNS_NOT_ACTIVATED"
+"DNS_NOT_ACTIVATED",
+"AUTO_RENEWAL_UPDATE_NOT_EFFECTIVE"
 ],
 "enumDescriptions": [
 "The issue is undefined.",
 "Contact the Cloud Support team to resolve a problem with this domain.",
 "[ICANN](https://icann.org/) requires verification of the email address in the `Registration`'s `contact_settings.registrant_contact` field. To verify the email address, follow the instructions in the email the `registrant_contact` receives following registration. If you do not complete email verification within 15 days of registration, the domain is suspended. To resend the verification email, call ConfigureContactSettings and provide the current `registrant_contact.email`.",
 "The billing account is not in good standing. The domain is not automatically renewed at its expiration time unless you resolve problems with your billing account.",
-"The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation."
+"The registry failed to validate your DNS configuration and activate your domain. The failure might happen for the following reasons: * You recently registered the domain (wait up to 72 hours). * You provided invalid name servers or name servers that correspond to a newly created DNS zone. Verify your DNS configuration. If the configuration is incorrect, you must fix it. If the configuration is correct, either wait or call the ConfigureDnsSettings method to retry the registry validation.",
+"Due to SquareSpace's constraints, the auto-renewal update you made may not be effective during a certain period of time. Generally, the time period is 15 days before expiration for generic TLD domains, and 15 days before expiration + 3 days after expiration for country-code TLD domains."
 ],
 "type": "string"
 },

From 105e7c99eaf1b91dbad2e09d967ec7998c866025 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:08 +0000
Subject: [PATCH 16/26] feat(eventarc): update the api

#### eventarc:v1

The following keys were added:
- schemas.GoogleApiSource.properties.organizationSubscription.$ref (Total Keys: 1)
- schemas.GoogleApiSource.properties.projectSubscriptions.$ref (Total Keys: 1)
- schemas.OrganizationSubscription (Total Keys: 3)
- schemas.ProjectSubscriptions (Total Keys: 4)
---
 ...1.projects.locations.googleApiSources.html | 32 +++++++++++++++++
 .../documents/eventarc.v1.json                | 35 ++++++++++++++++++-
 2 files changed, 66 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/eventarc_v1.projects.locations.googleApiSources.html b/docs/dyn/eventarc_v1.projects.locations.googleApiSources.html
index 75c6d8a77dc..b3b4832086b 100644
--- a/docs/dyn/eventarc_v1.projects.locations.googleApiSources.html
+++ b/docs/dyn/eventarc_v1.projects.locations.googleApiSources.html
@@ -135,6 +135,14 @@ 
Method Details

     "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
   },
   "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
+  "organizationSubscription": { # Config to enabled subscribing to events from other projects in the org. # Optional. Config to enable subscribing to events from all projects in the GoogleApiSource's org.
+    "enabled": True or False, # Required. Enable org level subscription.
+  },
+  "projectSubscriptions": { # Config to enable subscribing to all events from a list of projects. # Optional. Config to enable subscribing to all events from a list of projects. All the projects must be in the same org as the GoogleApiSource.
+    "list": [ # Required. A list of projects to receive events from. All the projects must be in the same org. The listed projects should have the format project/{identifier} where identifier can be either the project id for project number. A single list may contain both formats. At most 100 projects can be listed.
+      "A String",
+    ],
+  },
   "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
   "updateTime": "A String", # Output only. The last-modified time.
 }
@@ -238,6 +246,14 @@ 
Method Details

     "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
   },
   "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
+  "organizationSubscription": { # Config to enabled subscribing to events from other projects in the org. # Optional. Config to enable subscribing to events from all projects in the GoogleApiSource's org.
+    "enabled": True or False, # Required. Enable org level subscription.
+  },
+  "projectSubscriptions": { # Config to enable subscribing to all events from a list of projects. # Optional. Config to enable subscribing to all events from a list of projects. All the projects must be in the same org as the GoogleApiSource.
+    "list": [ # Required. A list of projects to receive events from. All the projects must be in the same org. The listed projects should have the format project/{identifier} where identifier can be either the project id for project number. A single list may contain both formats. At most 100 projects can be listed.
+      "A String",
+    ],
+  },
   "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
   "updateTime": "A String", # Output only. The last-modified time.
 }

@@ -327,6 +343,14 @@ 
Method Details

         "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
       },
       "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
+      "organizationSubscription": { # Config to enabled subscribing to events from other projects in the org. # Optional. Config to enable subscribing to events from all projects in the GoogleApiSource's org.
+        "enabled": True or False, # Required. Enable org level subscription.
+      },
+      "projectSubscriptions": { # Config to enable subscribing to all events from a list of projects. # Optional. Config to enable subscribing to all events from a list of projects. All the projects must be in the same org as the GoogleApiSource.
+        "list": [ # Required. A list of projects to receive events from. All the projects must be in the same org. The listed projects should have the format project/{identifier} where identifier can be either the project id for project number. A single list may contain both formats. At most 100 projects can be listed.
+          "A String",
+        ],
+      },
       "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
       "updateTime": "A String", # Output only. The last-modified time.
     },
@@ -377,6 +401,14 @@ 
Method Details

     "logSeverity": "A String", # Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.
   },
   "name": "A String", # Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}
+  "organizationSubscription": { # Config to enabled subscribing to events from other projects in the org. # Optional. Config to enable subscribing to events from all projects in the GoogleApiSource's org.
+    "enabled": True or False, # Required. Enable org level subscription.
+  },
+  "projectSubscriptions": { # Config to enable subscribing to all events from a list of projects. # Optional. Config to enable subscribing to all events from a list of projects. All the projects must be in the same org as the GoogleApiSource.
+    "list": [ # Required. A list of projects to receive events from. All the projects must be in the same org. The listed projects should have the format project/{identifier} where identifier can be either the project id for project number. A single list may contain both formats. At most 100 projects can be listed.
+      "A String",
+    ],
+  },
   "uid": "A String", # Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
   "updateTime": "A String", # Output only. The last-modified time.
 }
diff --git a/googleapiclient/discovery_cache/documents/eventarc.v1.json b/googleapiclient/discovery_cache/documents/eventarc.v1.json
index 4a2969352b2..07138516b83 100644
--- a/googleapiclient/discovery_cache/documents/eventarc.v1.json
+++ b/googleapiclient/discovery_cache/documents/eventarc.v1.json
@@ -2466,7 +2466,7 @@
 }
 }
 },
-"revision": "20250905",
+"revision": "20250912",
 "rootUrl": "https://eventarc.googleapis.com/",
 "schemas": {
 "AuditConfig": {
@@ -2951,6 +2951,14 @@
 "description": "Identifier. Resource name of the form projects/{project}/locations/{location}/googleApiSources/{google_api_source}",
 "type": "string"
 },
+"organizationSubscription": {
+"$ref": "OrganizationSubscription",
+"description": "Optional. Config to enable subscribing to events from all projects in the GoogleApiSource's org."
+},
+"projectSubscriptions": {
+"$ref": "ProjectSubscriptions",
+"description": "Optional. Config to enable subscribing to all events from a list of projects. All the projects must be in the same org as the GoogleApiSource."
+},
 "uid": {
 "description": "Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.",
 "readOnly": true,
@@ -3713,6 +3721,17 @@
 },
 "type": "object"
 },
+"OrganizationSubscription": {
+"description": "Config to enabled subscribing to events from other projects in the org.",
+"id": "OrganizationSubscription",
+"properties": {
+"enabled": {
+"description": "Required. Enable org level subscription.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "Pipeline": {
 "description": "A representation of the Pipeline resource.",
 "id": "Pipeline",
@@ -3830,6 +3849,20 @@
 },
 "type": "object"
 },
+"ProjectSubscriptions": {
+"description": "Config to enable subscribing to all events from a list of projects.",
+"id": "ProjectSubscriptions",
+"properties": {
+"list": {
+"description": "Required. A list of projects to receive events from. All the projects must be in the same org. The listed projects should have the format project/{identifier} where identifier can be either the project id for project number. A single list may contain both formats. At most 100 projects can be listed.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "Provider": {
 "description": "A representation of the Provider resource.",
 "id": "Provider",

From 7f3ac1010be4fa207d7b477575c671d5652f1767 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:08 +0000
Subject: [PATCH 17/26] feat(firebaseappdistribution): update the api

#### firebaseappdistribution:v1alpha

The following keys were added:
- resources.projects.resources.apps.resources.testCases.methods.patch.parameters.allowMissing (Total Keys: 2)
---
 ...aseappdistribution_v1alpha.projects.apps.testCases.html | 5 +++--
 .../documents/firebaseappdistribution.v1alpha.json         | 7 ++++++-
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html
index 6ef081ce0ce..9657a774eb6 100644
--- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html
+++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.testCases.html
@@ -96,7 +96,7 @@ 
Instance Methods

   list_next()

 
Retrieves the next page of results.

 

-  patch(name, body=None, x__xgafv=None)

+  patch(name, allowMissing=None, body=None, x__xgafv=None)

 
Update a test case.

 
Method Details

 

@@ -304,7 +304,7 @@ 
Method Details

 

 
 

-    patch(name, body=None, x__xgafv=None)
+    patch(name, allowMissing=None, body=None, x__xgafv=None)
   
Update a test case.
 
 Args:
@@ -333,6 +333,7 @@ 
Method Details

   "prerequisiteTestCase": "A String", # Optional. Test case that must be run before this test case.
 }
 
+  allowMissing: boolean, Optional. If set to true, and the test case is not found, a new test case will be created.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json
index d4e7a6170de..55495903bfb 100644
--- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json
@@ -747,6 +747,11 @@
 "name"
 ],
 "parameters": {
+"allowMissing": {
+"description": "Optional. If set to true, and the test case is not found, a new test case will be created.",
+"location": "query",
+"type": "boolean"
+},
 "name": {
 "description": "Identifier. The name of the test case resource. Format: `projects/{project_number}/apps/{app_id}/testCases/{test_case_id}`",
 "location": "path",
@@ -807,7 +812,7 @@
 }
 }
 },
-"revision": "20250912",
+"revision": "20250916",
 "rootUrl": "https://firebaseappdistribution.googleapis.com/",
 "schemas": {
 "AndroidxCrawlerOutputPoint": {

From 8805f0858edfc57c8707a8405a8d79c5a423bd32 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:08 +0000
Subject: [PATCH 18/26] feat(migrationcenter): update the api

#### migrationcenter:v1alpha1

The following keys were added:
- schemas.BiosDetails.properties.id.type (Total Keys: 1)
- schemas.BiosDetails.properties.manufacturer.type (Total Keys: 1)
- schemas.BiosDetails.properties.releaseTime (Total Keys: 2)
- schemas.BiosDetails.properties.version.type (Total Keys: 1)
- schemas.DiskEntry.properties.capacityBytes (Total Keys: 2)
- schemas.DiskEntry.properties.freeSpaceBytes (Total Keys: 2)
- schemas.GuestConfigDetails.properties.selinuxMode.type (Total Keys: 1)
- schemas.GuestInstalledApplication.properties.applicationName.type (Total Keys: 1)
- schemas.GuestInstalledApplication.properties.installTime (Total Keys: 2)
- schemas.GuestOsDetails.properties.family.type (Total Keys: 1)
- schemas.GuestOsDetails.properties.osName.type (Total Keys: 1)
- schemas.GuestOsDetails.properties.version.type (Total Keys: 1)
- schemas.GuestRuntimeDetails.properties.lastBootTime (Total Keys: 2)
- schemas.NetworkAdapterList.properties.entries (Total Keys: 2)
- schemas.NetworkAddressList.properties.entries (Total Keys: 2)
- schemas.ReportSummaryMachineFinding.properties.allocatedDiskTypes.deprecated (Total Keys: 1)
- schemas.RunningProcessList.properties.entries (Total Keys: 2)
- schemas.RunningService.properties.serviceName.type (Total Keys: 1)
- schemas.RunningServiceList.properties.entries (Total Keys: 2)
- schemas.RuntimeNetworkInfo.properties.rawScanResult.type (Total Keys: 1)
- schemas.RuntimeNetworkInfo.properties.scanTime (Total Keys: 2)
- schemas.VmwarePlatformDetails.properties.vcenterFolder.type (Total Keys: 1)
- schemas.VmwarePlatformDetails.properties.vcenterUri.type (Total Keys: 1)
- schemas.VmwarePlatformDetails.properties.vcenterVmId.type (Total Keys: 1)
---
 ...er_v1alpha1.projects.locations.assets.html | 1118 ++++++++++++++++-
 ...jects.locations.reportConfigs.reports.html |    6 +-
 ...rojects.locations.sources.errorFrames.html |  308 +++++
 .../documents/migrationcenter.v1alpha1.json   |  139 +-
 4 files changed, 1546 insertions(+), 25 deletions(-)

diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
index 9f4ed16439a..529fd11b68a 100644
--- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
+++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.assets.html
@@ -525,7 +525,11 @@ 
Method Details

               "biosName": "A String", # BIOS name.
               "biosReleaseDate": "A String", # BIOS release date.
               "biosVersion": "A String", # BIOS version.
+              "id": "A String", # BIOS ID.
+              "manufacturer": "A String", # BIOS manufacturer.
+              "releaseTime": "A String", # BIOS release date.
               "smbiosUuid": "A String", # SMBIOS UUID.
+              "version": "A String", # BIOS version.
             },
             "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
             "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD".
@@ -558,8 +562,10 @@ 
Method Details

             "disks": { # VM disks. # List of disks.
               "entries": [ # Disk entries.
                 { # Single disk entry.
+                  "capacityBytes": "A String", # Disk capacity.
                   "diskLabel": "A String", # Disk label.
                   "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+                  "freeSpaceBytes": "A String", # Disk free space.
                   "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
                   "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
                   "partitions": { # Disk partition list. # Partition layout.
@@ -624,12 +630,17 @@ 
Method Details

                 "enabled": True or False, # Is SELinux enabled.
                 "mode": "A String", # SELinux mode enforcing / permissive.
               },
+              "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
             },
+            "family": "A String", # What family the OS belong to, if known.
+            "osName": "A String", # The name of the operating system.
             "runtime": { # Guest OS runtime information. # Runtime information.
               "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
               "installedApps": { # Guest installed application list. # Installed applications information.
                 "entries": [ # Application entries.
                   { # Guest installed application information.
+                    "applicationName": "A String", # Installed application name.
+                    "installTime": "A String", # The time when the application was installed.
                     "licenses": [ # License strings associated with the installed application.
                       "A String",
                     ],
@@ -641,6 +652,7 @@ 
Method Details

                   },
                 ],
               },
+              "lastBootTime": "A String", # Last time the OS was booted.
               "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
                 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -677,6 +689,8 @@ 
Method Details

                   "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                   "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                 },
+                "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+                "scanTime": "A String", # Time of the last network scan.
               },
               "openFileList": { # Open file list. # Open files information.
                 "entries": [ # Open file details entries.
@@ -689,6 +703,17 @@ 
Method Details

                 ],
               },
               "processes": { # List of running guest OS processes. # Running processes.
+                "entries": [ # Running process entries.
+                  { # Guest OS running process details.
+                    "attributes": { # Process extended attributes.
+                      "a_key": "A String",
+                    },
+                    "cmdline": "A String", # Process full command line.
+                    "exePath": "A String", # Process binary path.
+                    "pid": "A String", # Process ID.
+                    "user": "A String", # User running the process.
+                  },
+                ],
                 "processes": [ # Running process entries.
                   { # Guest OS running process details.
                     "attributes": { # Process extended attributes.
@@ -702,12 +727,25 @@ 
Method Details

                 ],
               },
               "services": { # List of running guest OS services. # Running background services.
+                "entries": [ # Running service entries.
+                  { # Guest OS running service details.
+                    "cmdline": "A String", # Service command line.
+                    "exePath": "A String", # Service binary path.
+                    "name": "A String", # Service name.
+                    "pid": "A String", # Service pid.
+                    "serviceName": "A String", # Service name.
+                    "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                    "state": "A String", # Service state (raw, OS-agnostic).
+                    "status": "A String", # Service status.
+                  },
+                ],
                 "services": [ # Running service entries.
                   { # Guest OS running service details.
                     "cmdline": "A String", # Service command line.
                     "exePath": "A String", # Service binary path.
                     "name": "A String", # Service name.
                     "pid": "A String", # Service pid.
+                    "serviceName": "A String", # Service name.
                     "startMode": "A String", # Service start mode (raw, OS-agnostic).
                     "state": "A String", # Service state (raw, OS-agnostic).
                     "status": "A String", # Service status.
@@ -715,12 +753,39 @@ 
Method Details

                 ],
               },
             },
+            "version": "A String", # The version of the operating system.
           },
           "machineName": "A String", # Machine name.
           "memoryMb": 42, # The amount of memory in the machine. Must be non-negative.
           "network": { # Details of network adapters and settings. # Network details.
             "defaultGateway": "A String", # Default gateway address.
             "networkAdapters": { # List of network adapters. # List of network adapters.
+              "entries": [ # Network adapter entries.
+                { # Details of network adapter.
+                  "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+                  "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                    "addresses": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
+                    "entries": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
+                  },
+                  "macAddress": "A String", # MAC address.
+                },
+              ],
               "networkAdapters": [ # Network adapter descriptions.
                 { # Details of network adapter.
                   "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -734,6 +799,15 @@ 
Method Details

                         "subnetMask": "A String", # Subnet mask.
                       },
                     ],
+                    "entries": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
                   },
                   "macAddress": "A String", # MAC address.
                 },
@@ -767,7 +841,10 @@ 
Method Details

               "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
               "esxVersion": "A String", # ESX version.
               "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+              "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+              "vcenterUri": "A String", # vCenter URI used in collection.
               "vcenterVersion": "A String", # vCenter version.
+              "vcenterVmId": "A String", # vCenter VM ID.
             },
           },
           "powerState": "A String", # Power state of the machine.
@@ -902,12 +979,17 @@ 
Method Details

                 "enabled": True or False, # Is SELinux enabled.
                 "mode": "A String", # SELinux mode enforcing / permissive.
               },
+              "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
             },
+            "family": "A String", # What family the OS belong to, if known.
+            "osName": "A String", # The name of the operating system.
             "runtime": { # Guest OS runtime information. # Runtime information.
               "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
               "installedApps": { # Guest installed application list. # Installed applications information.
                 "entries": [ # Application entries.
                   { # Guest installed application information.
+                    "applicationName": "A String", # Installed application name.
+                    "installTime": "A String", # The time when the application was installed.
                     "licenses": [ # License strings associated with the installed application.
                       "A String",
                     ],
@@ -919,6 +1001,7 @@ 
Method Details

                   },
                 ],
               },
+              "lastBootTime": "A String", # Last time the OS was booted.
               "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
                 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -955,6 +1038,8 @@ 
Method Details

                   "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                   "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                 },
+                "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+                "scanTime": "A String", # Time of the last network scan.
               },
               "openFileList": { # Open file list. # Open files information.
                 "entries": [ # Open file details entries.
@@ -967,6 +1052,17 @@ 
Method Details

                 ],
               },
               "processes": { # List of running guest OS processes. # Running processes.
+                "entries": [ # Running process entries.
+                  { # Guest OS running process details.
+                    "attributes": { # Process extended attributes.
+                      "a_key": "A String",
+                    },
+                    "cmdline": "A String", # Process full command line.
+                    "exePath": "A String", # Process binary path.
+                    "pid": "A String", # Process ID.
+                    "user": "A String", # User running the process.
+                  },
+                ],
                 "processes": [ # Running process entries.
                   { # Guest OS running process details.
                     "attributes": { # Process extended attributes.
@@ -980,12 +1076,25 @@ 
Method Details

                 ],
               },
               "services": { # List of running guest OS services. # Running background services.
+                "entries": [ # Running service entries.
+                  { # Guest OS running service details.
+                    "cmdline": "A String", # Service command line.
+                    "exePath": "A String", # Service binary path.
+                    "name": "A String", # Service name.
+                    "pid": "A String", # Service pid.
+                    "serviceName": "A String", # Service name.
+                    "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                    "state": "A String", # Service state (raw, OS-agnostic).
+                    "status": "A String", # Service status.
+                  },
+                ],
                 "services": [ # Running service entries.
                   { # Guest OS running service details.
                     "cmdline": "A String", # Service command line.
                     "exePath": "A String", # Service binary path.
                     "name": "A String", # Service name.
                     "pid": "A String", # Service pid.
+                    "serviceName": "A String", # Service name.
                     "startMode": "A String", # Service start mode (raw, OS-agnostic).
                     "state": "A String", # Service state (raw, OS-agnostic).
                     "status": "A String", # Service status.
@@ -993,6 +1102,7 @@ 
Method Details

                 ],
               },
             },
+            "version": "A String", # The version of the operating system.
           },
           "memoryMb": 42, # The amount of memory in the VirtualMachine. Must be non-negative.
           "osFamily": "A String", # What family the OS belong to, if known.
@@ -1022,7 +1132,10 @@ 
Method Details

               "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
               "esxVersion": "A String", # ESX version.
               "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+              "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+              "vcenterUri": "A String", # vCenter URI used in collection.
               "vcenterVersion": "A String", # vCenter version.
+              "vcenterVmId": "A String", # vCenter VM ID.
             },
           },
           "powerState": "A String", # Power state of VM (poweredOn or poweredOff).
@@ -1035,7 +1148,11 @@ 
Method Details

               "biosName": "A String", # BIOS name.
               "biosReleaseDate": "A String", # BIOS release date.
               "biosVersion": "A String", # BIOS version.
+              "id": "A String", # BIOS ID.
+              "manufacturer": "A String", # BIOS manufacturer.
+              "releaseTime": "A String", # BIOS release date.
               "smbiosUuid": "A String", # SMBIOS UUID.
+              "version": "A String", # BIOS version.
             },
             "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
             "cpuManufacturer": "A String", # CPU manufacturer, e.g., "Intel", "AMD".
@@ -1050,8 +1167,10 @@ 
Method Details

             "disks": { # VM disks. # List of disks.
               "entries": [ # Disk entries.
                 { # Single disk entry.
+                  "capacityBytes": "A String", # Disk capacity.
                   "diskLabel": "A String", # Disk label.
                   "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+                  "freeSpaceBytes": "A String", # Disk free space.
                   "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
                   "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
                   "partitions": { # Disk partition list. # Partition layout.
@@ -1081,6 +1200,32 @@ 
Method Details

           "vmNetwork": { # Details of network adapters and settings. # VM network details.
             "defaultGw": "A String", # Default gateway address.
             "networkAdapters": { # List of network adapters. # List of network adapters.
+              "entries": [ # Network adapter entries.
+                { # Details of network adapter.
+                  "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+                  "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                    "addresses": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
+                    "entries": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
+                  },
+                  "macAddress": "A String", # MAC address.
+                },
+              ],
               "networkAdapters": [ # Network adapter descriptions.
                 { # Details of network adapter.
                   "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -1094,6 +1239,15 @@ 
Method Details

                         "subnetMask": "A String", # Subnet mask.
                       },
                     ],
+                    "entries": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
                   },
                   "macAddress": "A String", # MAC address.
                 },
@@ -1429,7 +1583,11 @@ 
Method Details

             "biosName": "A String", # BIOS name.
             "biosReleaseDate": "A String", # BIOS release date.
             "biosVersion": "A String", # BIOS version.
+            "id": "A String", # BIOS ID.
+            "manufacturer": "A String", # BIOS manufacturer.
+            "releaseTime": "A String", # BIOS release date.
             "smbiosUuid": "A String", # SMBIOS UUID.
+            "version": "A String", # BIOS version.
           },
           "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
           "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD".
@@ -1462,8 +1620,10 @@ 
Method Details

           "disks": { # VM disks. # List of disks.
             "entries": [ # Disk entries.
               { # Single disk entry.
+                "capacityBytes": "A String", # Disk capacity.
                 "diskLabel": "A String", # Disk label.
                 "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+                "freeSpaceBytes": "A String", # Disk free space.
                 "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
                 "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
                 "partitions": { # Disk partition list. # Partition layout.
@@ -1528,12 +1688,17 @@ 
Method Details

               "enabled": True or False, # Is SELinux enabled.
               "mode": "A String", # SELinux mode enforcing / permissive.
             },
+            "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
           },
+          "family": "A String", # What family the OS belong to, if known.
+          "osName": "A String", # The name of the operating system.
           "runtime": { # Guest OS runtime information. # Runtime information.
             "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
             "installedApps": { # Guest installed application list. # Installed applications information.
               "entries": [ # Application entries.
                 { # Guest installed application information.
+                  "applicationName": "A String", # Installed application name.
+                  "installTime": "A String", # The time when the application was installed.
                   "licenses": [ # License strings associated with the installed application.
                     "A String",
                   ],
@@ -1545,6 +1710,7 @@ 
Method Details

                 },
               ],
             },
+            "lastBootTime": "A String", # Last time the OS was booted.
             "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
               "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
               "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -1581,6 +1747,8 @@ 
Method Details

                 "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                 "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
               },
+              "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+              "scanTime": "A String", # Time of the last network scan.
             },
             "openFileList": { # Open file list. # Open files information.
               "entries": [ # Open file details entries.
@@ -1593,6 +1761,17 @@ 
Method Details

               ],
             },
             "processes": { # List of running guest OS processes. # Running processes.
+              "entries": [ # Running process entries.
+                { # Guest OS running process details.
+                  "attributes": { # Process extended attributes.
+                    "a_key": "A String",
+                  },
+                  "cmdline": "A String", # Process full command line.
+                  "exePath": "A String", # Process binary path.
+                  "pid": "A String", # Process ID.
+                  "user": "A String", # User running the process.
+                },
+              ],
               "processes": [ # Running process entries.
                 { # Guest OS running process details.
                   "attributes": { # Process extended attributes.
@@ -1606,12 +1785,25 @@ 
Method Details

               ],
             },
             "services": { # List of running guest OS services. # Running background services.
+              "entries": [ # Running service entries.
+                { # Guest OS running service details.
+                  "cmdline": "A String", # Service command line.
+                  "exePath": "A String", # Service binary path.
+                  "name": "A String", # Service name.
+                  "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
+                  "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                  "state": "A String", # Service state (raw, OS-agnostic).
+                  "status": "A String", # Service status.
+                },
+              ],
               "services": [ # Running service entries.
                 { # Guest OS running service details.
                   "cmdline": "A String", # Service command line.
                   "exePath": "A String", # Service binary path.
                   "name": "A String", # Service name.
                   "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
                   "startMode": "A String", # Service start mode (raw, OS-agnostic).
                   "state": "A String", # Service state (raw, OS-agnostic).
                   "status": "A String", # Service status.
@@ -1619,12 +1811,39 @@ 
Method Details

               ],
             },
           },
+          "version": "A String", # The version of the operating system.
         },
         "machineName": "A String", # Machine name.
         "memoryMb": 42, # The amount of memory in the machine. Must be non-negative.
         "network": { # Details of network adapters and settings. # Network details.
           "defaultGateway": "A String", # Default gateway address.
           "networkAdapters": { # List of network adapters. # List of network adapters.
+            "entries": [ # Network adapter entries.
+              { # Details of network adapter.
+                "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+                "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                  "addresses": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                },
+                "macAddress": "A String", # MAC address.
+              },
+            ],
             "networkAdapters": [ # Network adapter descriptions.
               { # Details of network adapter.
                 "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -1638,6 +1857,15 @@ 
Method Details

                       "subnetMask": "A String", # Subnet mask.
                     },
                   ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
                 },
                 "macAddress": "A String", # MAC address.
               },
@@ -1671,7 +1899,10 @@ 
Method Details

             "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
             "esxVersion": "A String", # ESX version.
             "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+            "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+            "vcenterUri": "A String", # vCenter URI used in collection.
             "vcenterVersion": "A String", # vCenter version.
+            "vcenterVmId": "A String", # vCenter VM ID.
           },
         },
         "powerState": "A String", # Power state of the machine.
@@ -1806,12 +2037,17 @@ 
Method Details

               "enabled": True or False, # Is SELinux enabled.
               "mode": "A String", # SELinux mode enforcing / permissive.
             },
+            "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
           },
+          "family": "A String", # What family the OS belong to, if known.
+          "osName": "A String", # The name of the operating system.
           "runtime": { # Guest OS runtime information. # Runtime information.
             "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
             "installedApps": { # Guest installed application list. # Installed applications information.
               "entries": [ # Application entries.
                 { # Guest installed application information.
+                  "applicationName": "A String", # Installed application name.
+                  "installTime": "A String", # The time when the application was installed.
                   "licenses": [ # License strings associated with the installed application.
                     "A String",
                   ],
@@ -1823,6 +2059,7 @@ 
Method Details

                 },
               ],
             },
+            "lastBootTime": "A String", # Last time the OS was booted.
             "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
               "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
               "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -1859,6 +2096,8 @@ 
Method Details

                 "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                 "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
               },
+              "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+              "scanTime": "A String", # Time of the last network scan.
             },
             "openFileList": { # Open file list. # Open files information.
               "entries": [ # Open file details entries.
@@ -1871,6 +2110,17 @@ 
Method Details

               ],
             },
             "processes": { # List of running guest OS processes. # Running processes.
+              "entries": [ # Running process entries.
+                { # Guest OS running process details.
+                  "attributes": { # Process extended attributes.
+                    "a_key": "A String",
+                  },
+                  "cmdline": "A String", # Process full command line.
+                  "exePath": "A String", # Process binary path.
+                  "pid": "A String", # Process ID.
+                  "user": "A String", # User running the process.
+                },
+              ],
               "processes": [ # Running process entries.
                 { # Guest OS running process details.
                   "attributes": { # Process extended attributes.
@@ -1884,12 +2134,25 @@ 
Method Details

               ],
             },
             "services": { # List of running guest OS services. # Running background services.
+              "entries": [ # Running service entries.
+                { # Guest OS running service details.
+                  "cmdline": "A String", # Service command line.
+                  "exePath": "A String", # Service binary path.
+                  "name": "A String", # Service name.
+                  "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
+                  "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                  "state": "A String", # Service state (raw, OS-agnostic).
+                  "status": "A String", # Service status.
+                },
+              ],
               "services": [ # Running service entries.
                 { # Guest OS running service details.
                   "cmdline": "A String", # Service command line.
                   "exePath": "A String", # Service binary path.
                   "name": "A String", # Service name.
                   "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
                   "startMode": "A String", # Service start mode (raw, OS-agnostic).
                   "state": "A String", # Service state (raw, OS-agnostic).
                   "status": "A String", # Service status.
@@ -1897,6 +2160,7 @@ 
Method Details

               ],
             },
           },
+          "version": "A String", # The version of the operating system.
         },
         "memoryMb": 42, # The amount of memory in the VirtualMachine. Must be non-negative.
         "osFamily": "A String", # What family the OS belong to, if known.
@@ -1926,7 +2190,10 @@ 
Method Details

             "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
             "esxVersion": "A String", # ESX version.
             "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+            "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+            "vcenterUri": "A String", # vCenter URI used in collection.
             "vcenterVersion": "A String", # vCenter version.
+            "vcenterVmId": "A String", # vCenter VM ID.
           },
         },
         "powerState": "A String", # Power state of VM (poweredOn or poweredOff).
@@ -1939,7 +2206,11 @@ 
Method Details

             "biosName": "A String", # BIOS name.
             "biosReleaseDate": "A String", # BIOS release date.
             "biosVersion": "A String", # BIOS version.
+            "id": "A String", # BIOS ID.
+            "manufacturer": "A String", # BIOS manufacturer.
+            "releaseTime": "A String", # BIOS release date.
             "smbiosUuid": "A String", # SMBIOS UUID.
+            "version": "A String", # BIOS version.
           },
           "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
           "cpuManufacturer": "A String", # CPU manufacturer, e.g., "Intel", "AMD".
@@ -1954,8 +2225,10 @@ 
Method Details

           "disks": { # VM disks. # List of disks.
             "entries": [ # Disk entries.
               { # Single disk entry.
+                "capacityBytes": "A String", # Disk capacity.
                 "diskLabel": "A String", # Disk label.
                 "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+                "freeSpaceBytes": "A String", # Disk free space.
                 "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
                 "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
                 "partitions": { # Disk partition list. # Partition layout.
@@ -1985,6 +2258,32 @@ 
Method Details

         "vmNetwork": { # Details of network adapters and settings. # VM network details.
           "defaultGw": "A String", # Default gateway address.
           "networkAdapters": { # List of network adapters. # List of network adapters.
+            "entries": [ # Network adapter entries.
+              { # Details of network adapter.
+                "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+                "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                  "addresses": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                },
+                "macAddress": "A String", # MAC address.
+              },
+            ],
             "networkAdapters": [ # Network adapter descriptions.
               { # Details of network adapter.
                 "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -1998,6 +2297,15 @@ 
Method Details

                       "subnetMask": "A String", # Subnet mask.
                     },
                   ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
                 },
                 "macAddress": "A String", # MAC address.
               },
@@ -2365,7 +2673,11 @@ 
Method Details

         "biosName": "A String", # BIOS name.
         "biosReleaseDate": "A String", # BIOS release date.
         "biosVersion": "A String", # BIOS version.
+        "id": "A String", # BIOS ID.
+        "manufacturer": "A String", # BIOS manufacturer.
+        "releaseTime": "A String", # BIOS release date.
         "smbiosUuid": "A String", # SMBIOS UUID.
+        "version": "A String", # BIOS version.
       },
       "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
       "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD".
@@ -2398,8 +2710,10 @@ 
Method Details

       "disks": { # VM disks. # List of disks.
         "entries": [ # Disk entries.
           { # Single disk entry.
+            "capacityBytes": "A String", # Disk capacity.
             "diskLabel": "A String", # Disk label.
             "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+            "freeSpaceBytes": "A String", # Disk free space.
             "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
             "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
             "partitions": { # Disk partition list. # Partition layout.
@@ -2464,12 +2778,17 @@ 
Method Details

           "enabled": True or False, # Is SELinux enabled.
           "mode": "A String", # SELinux mode enforcing / permissive.
         },
+        "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
       },
+      "family": "A String", # What family the OS belong to, if known.
+      "osName": "A String", # The name of the operating system.
       "runtime": { # Guest OS runtime information. # Runtime information.
         "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
         "installedApps": { # Guest installed application list. # Installed applications information.
           "entries": [ # Application entries.
             { # Guest installed application information.
+              "applicationName": "A String", # Installed application name.
+              "installTime": "A String", # The time when the application was installed.
               "licenses": [ # License strings associated with the installed application.
                 "A String",
               ],
@@ -2481,6 +2800,7 @@ 
Method Details

             },
           ],
         },
+        "lastBootTime": "A String", # Last time the OS was booted.
         "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
           "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
           "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -2517,6 +2837,8 @@ 
Method Details

             "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
             "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
           },
+          "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+          "scanTime": "A String", # Time of the last network scan.
         },
         "openFileList": { # Open file list. # Open files information.
           "entries": [ # Open file details entries.
@@ -2529,6 +2851,17 @@ 
Method Details

           ],
         },
         "processes": { # List of running guest OS processes. # Running processes.
+          "entries": [ # Running process entries.
+            { # Guest OS running process details.
+              "attributes": { # Process extended attributes.
+                "a_key": "A String",
+              },
+              "cmdline": "A String", # Process full command line.
+              "exePath": "A String", # Process binary path.
+              "pid": "A String", # Process ID.
+              "user": "A String", # User running the process.
+            },
+          ],
           "processes": [ # Running process entries.
             { # Guest OS running process details.
               "attributes": { # Process extended attributes.
@@ -2542,12 +2875,25 @@ 
Method Details

           ],
         },
         "services": { # List of running guest OS services. # Running background services.
+          "entries": [ # Running service entries.
+            { # Guest OS running service details.
+              "cmdline": "A String", # Service command line.
+              "exePath": "A String", # Service binary path.
+              "name": "A String", # Service name.
+              "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
+              "startMode": "A String", # Service start mode (raw, OS-agnostic).
+              "state": "A String", # Service state (raw, OS-agnostic).
+              "status": "A String", # Service status.
+            },
+          ],
           "services": [ # Running service entries.
             { # Guest OS running service details.
               "cmdline": "A String", # Service command line.
               "exePath": "A String", # Service binary path.
               "name": "A String", # Service name.
               "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
               "startMode": "A String", # Service start mode (raw, OS-agnostic).
               "state": "A String", # Service state (raw, OS-agnostic).
               "status": "A String", # Service status.
@@ -2555,13 +2901,14 @@ 
Method Details

           ],
         },
       },
+      "version": "A String", # The version of the operating system.
     },
     "machineName": "A String", # Machine name.
     "memoryMb": 42, # The amount of memory in the machine. Must be non-negative.
     "network": { # Details of network adapters and settings. # Network details.
       "defaultGateway": "A String", # Default gateway address.
       "networkAdapters": { # List of network adapters. # List of network adapters.
-        "networkAdapters": [ # Network adapter descriptions.
+        "entries": [ # Network adapter entries.
           { # Details of network adapter.
             "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
             "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
@@ -2574,29 +2921,64 @@ 
Method Details

                   "subnetMask": "A String", # Subnet mask.
                 },
               ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
             },
             "macAddress": "A String", # MAC address.
           },
         ],
-      },
-      "primaryIpAddress": "A String", # The primary IP address of the machine.
-      "primaryMacAddress": "A String", # MAC address of the machine. This property is used to uniqly identify the machine.
-      "publicIpAddress": "A String", # The public IP address of the machine.
-    },
-    "platform": { # Information about the platform. # Platform specific information.
-      "awsEc2Details": { # AWS EC2 specific details. # AWS EC2 specific details.
-        "hyperthreading": "A String", # Optional. Whether the machine is hyperthreaded.
-        "location": "A String", # The location of the machine in the AWS format.
-        "machineTypeLabel": "A String", # AWS platform's machine type label.
-      },
-      "azureVmDetails": { # Azure VM specific details. # Azure VM specific details.
-        "hyperthreading": "A String", # Whether the machine is hyperthreaded.
-        "location": "A String", # The location of the machine in the Azure format.
-        "machineTypeLabel": "A String", # Azure platform's machine type label.
-        "provisioningState": "A String", # Azure platform's provisioning state.
-      },
-      "genericDetails": { # Generic platform details. # Generic platform details.
-        "hyperthreading": "A String", # Whether the machine is hyperthreaded.
+        "networkAdapters": [ # Network adapter descriptions.
+          { # Details of network adapter.
+            "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+            "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+              "addresses": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+            },
+            "macAddress": "A String", # MAC address.
+          },
+        ],
+      },
+      "primaryIpAddress": "A String", # The primary IP address of the machine.
+      "primaryMacAddress": "A String", # MAC address of the machine. This property is used to uniqly identify the machine.
+      "publicIpAddress": "A String", # The public IP address of the machine.
+    },
+    "platform": { # Information about the platform. # Platform specific information.
+      "awsEc2Details": { # AWS EC2 specific details. # AWS EC2 specific details.
+        "hyperthreading": "A String", # Optional. Whether the machine is hyperthreaded.
+        "location": "A String", # The location of the machine in the AWS format.
+        "machineTypeLabel": "A String", # AWS platform's machine type label.
+      },
+      "azureVmDetails": { # Azure VM specific details. # Azure VM specific details.
+        "hyperthreading": "A String", # Whether the machine is hyperthreaded.
+        "location": "A String", # The location of the machine in the Azure format.
+        "machineTypeLabel": "A String", # Azure platform's machine type label.
+        "provisioningState": "A String", # Azure platform's provisioning state.
+      },
+      "genericDetails": { # Generic platform details. # Generic platform details.
+        "hyperthreading": "A String", # Whether the machine is hyperthreaded.
         "location": "A String", # Free text representation of the machine location. The format of this field should not be relied on. Different VMs in the same location may have different string values for this field.
       },
       "physicalDetails": { # Platform specific details for Physical Machines. # Physical machines platform details.
@@ -2607,7 +2989,10 @@ 
Method Details

         "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
         "esxVersion": "A String", # ESX version.
         "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+        "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+        "vcenterUri": "A String", # vCenter URI used in collection.
         "vcenterVersion": "A String", # vCenter version.
+        "vcenterVmId": "A String", # vCenter VM ID.
       },
     },
     "powerState": "A String", # Power state of the machine.
@@ -2742,12 +3127,17 @@ 
Method Details

           "enabled": True or False, # Is SELinux enabled.
           "mode": "A String", # SELinux mode enforcing / permissive.
         },
+        "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
       },
+      "family": "A String", # What family the OS belong to, if known.
+      "osName": "A String", # The name of the operating system.
       "runtime": { # Guest OS runtime information. # Runtime information.
         "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
         "installedApps": { # Guest installed application list. # Installed applications information.
           "entries": [ # Application entries.
             { # Guest installed application information.
+              "applicationName": "A String", # Installed application name.
+              "installTime": "A String", # The time when the application was installed.
               "licenses": [ # License strings associated with the installed application.
                 "A String",
               ],
@@ -2759,6 +3149,7 @@ 
Method Details

             },
           ],
         },
+        "lastBootTime": "A String", # Last time the OS was booted.
         "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
           "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
           "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -2795,6 +3186,8 @@ 
Method Details

             "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
             "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
           },
+          "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+          "scanTime": "A String", # Time of the last network scan.
         },
         "openFileList": { # Open file list. # Open files information.
           "entries": [ # Open file details entries.
@@ -2807,6 +3200,17 @@ 
Method Details

           ],
         },
         "processes": { # List of running guest OS processes. # Running processes.
+          "entries": [ # Running process entries.
+            { # Guest OS running process details.
+              "attributes": { # Process extended attributes.
+                "a_key": "A String",
+              },
+              "cmdline": "A String", # Process full command line.
+              "exePath": "A String", # Process binary path.
+              "pid": "A String", # Process ID.
+              "user": "A String", # User running the process.
+            },
+          ],
           "processes": [ # Running process entries.
             { # Guest OS running process details.
               "attributes": { # Process extended attributes.
@@ -2820,12 +3224,25 @@ 
Method Details

           ],
         },
         "services": { # List of running guest OS services. # Running background services.
+          "entries": [ # Running service entries.
+            { # Guest OS running service details.
+              "cmdline": "A String", # Service command line.
+              "exePath": "A String", # Service binary path.
+              "name": "A String", # Service name.
+              "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
+              "startMode": "A String", # Service start mode (raw, OS-agnostic).
+              "state": "A String", # Service state (raw, OS-agnostic).
+              "status": "A String", # Service status.
+            },
+          ],
           "services": [ # Running service entries.
             { # Guest OS running service details.
               "cmdline": "A String", # Service command line.
               "exePath": "A String", # Service binary path.
               "name": "A String", # Service name.
               "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
               "startMode": "A String", # Service start mode (raw, OS-agnostic).
               "state": "A String", # Service state (raw, OS-agnostic).
               "status": "A String", # Service status.
@@ -2833,6 +3250,7 @@ 
Method Details

           ],
         },
       },
+      "version": "A String", # The version of the operating system.
     },
     "memoryMb": 42, # The amount of memory in the VirtualMachine. Must be non-negative.
     "osFamily": "A String", # What family the OS belong to, if known.
@@ -2862,7 +3280,10 @@ 
Method Details

         "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
         "esxVersion": "A String", # ESX version.
         "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+        "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+        "vcenterUri": "A String", # vCenter URI used in collection.
         "vcenterVersion": "A String", # vCenter version.
+        "vcenterVmId": "A String", # vCenter VM ID.
       },
     },
     "powerState": "A String", # Power state of VM (poweredOn or poweredOff).
@@ -2875,7 +3296,11 @@ 
Method Details

         "biosName": "A String", # BIOS name.
         "biosReleaseDate": "A String", # BIOS release date.
         "biosVersion": "A String", # BIOS version.
+        "id": "A String", # BIOS ID.
+        "manufacturer": "A String", # BIOS manufacturer.
+        "releaseTime": "A String", # BIOS release date.
         "smbiosUuid": "A String", # SMBIOS UUID.
+        "version": "A String", # BIOS version.
       },
       "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
       "cpuManufacturer": "A String", # CPU manufacturer, e.g., "Intel", "AMD".
@@ -2890,8 +3315,10 @@ 
Method Details

       "disks": { # VM disks. # List of disks.
         "entries": [ # Disk entries.
           { # Single disk entry.
+            "capacityBytes": "A String", # Disk capacity.
             "diskLabel": "A String", # Disk label.
             "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+            "freeSpaceBytes": "A String", # Disk free space.
             "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
             "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
             "partitions": { # Disk partition list. # Partition layout.
@@ -2921,6 +3348,32 @@ 
Method Details

     "vmNetwork": { # Details of network adapters and settings. # VM network details.
       "defaultGw": "A String", # Default gateway address.
       "networkAdapters": { # List of network adapters. # List of network adapters.
+        "entries": [ # Network adapter entries.
+          { # Details of network adapter.
+            "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+            "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+              "addresses": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+            },
+            "macAddress": "A String", # MAC address.
+          },
+        ],
         "networkAdapters": [ # Network adapter descriptions.
           { # Details of network adapter.
             "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -2934,6 +3387,15 @@ 
Method Details

                   "subnetMask": "A String", # Subnet mask.
                 },
               ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
             },
             "macAddress": "A String", # MAC address.
           },
@@ -3282,7 +3744,11 @@ 
Method Details

             "biosName": "A String", # BIOS name.
             "biosReleaseDate": "A String", # BIOS release date.
             "biosVersion": "A String", # BIOS version.
+            "id": "A String", # BIOS ID.
+            "manufacturer": "A String", # BIOS manufacturer.
+            "releaseTime": "A String", # BIOS release date.
             "smbiosUuid": "A String", # SMBIOS UUID.
+            "version": "A String", # BIOS version.
           },
           "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
           "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD".
@@ -3315,8 +3781,10 @@ 
Method Details

           "disks": { # VM disks. # List of disks.
             "entries": [ # Disk entries.
               { # Single disk entry.
+                "capacityBytes": "A String", # Disk capacity.
                 "diskLabel": "A String", # Disk label.
                 "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+                "freeSpaceBytes": "A String", # Disk free space.
                 "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
                 "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
                 "partitions": { # Disk partition list. # Partition layout.
@@ -3381,12 +3849,17 @@ 
Method Details

               "enabled": True or False, # Is SELinux enabled.
               "mode": "A String", # SELinux mode enforcing / permissive.
             },
+            "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
           },
+          "family": "A String", # What family the OS belong to, if known.
+          "osName": "A String", # The name of the operating system.
           "runtime": { # Guest OS runtime information. # Runtime information.
             "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
             "installedApps": { # Guest installed application list. # Installed applications information.
               "entries": [ # Application entries.
                 { # Guest installed application information.
+                  "applicationName": "A String", # Installed application name.
+                  "installTime": "A String", # The time when the application was installed.
                   "licenses": [ # License strings associated with the installed application.
                     "A String",
                   ],
@@ -3398,6 +3871,7 @@ 
Method Details

                 },
               ],
             },
+            "lastBootTime": "A String", # Last time the OS was booted.
             "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
               "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
               "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -3434,6 +3908,8 @@ 
Method Details

                 "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                 "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
               },
+              "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+              "scanTime": "A String", # Time of the last network scan.
             },
             "openFileList": { # Open file list. # Open files information.
               "entries": [ # Open file details entries.
@@ -3446,6 +3922,17 @@ 
Method Details

               ],
             },
             "processes": { # List of running guest OS processes. # Running processes.
+              "entries": [ # Running process entries.
+                { # Guest OS running process details.
+                  "attributes": { # Process extended attributes.
+                    "a_key": "A String",
+                  },
+                  "cmdline": "A String", # Process full command line.
+                  "exePath": "A String", # Process binary path.
+                  "pid": "A String", # Process ID.
+                  "user": "A String", # User running the process.
+                },
+              ],
               "processes": [ # Running process entries.
                 { # Guest OS running process details.
                   "attributes": { # Process extended attributes.
@@ -3459,12 +3946,25 @@ 
Method Details

               ],
             },
             "services": { # List of running guest OS services. # Running background services.
+              "entries": [ # Running service entries.
+                { # Guest OS running service details.
+                  "cmdline": "A String", # Service command line.
+                  "exePath": "A String", # Service binary path.
+                  "name": "A String", # Service name.
+                  "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
+                  "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                  "state": "A String", # Service state (raw, OS-agnostic).
+                  "status": "A String", # Service status.
+                },
+              ],
               "services": [ # Running service entries.
                 { # Guest OS running service details.
                   "cmdline": "A String", # Service command line.
                   "exePath": "A String", # Service binary path.
                   "name": "A String", # Service name.
                   "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
                   "startMode": "A String", # Service start mode (raw, OS-agnostic).
                   "state": "A String", # Service state (raw, OS-agnostic).
                   "status": "A String", # Service status.
@@ -3472,12 +3972,39 @@ 
Method Details

               ],
             },
           },
+          "version": "A String", # The version of the operating system.
         },
         "machineName": "A String", # Machine name.
         "memoryMb": 42, # The amount of memory in the machine. Must be non-negative.
         "network": { # Details of network adapters and settings. # Network details.
           "defaultGateway": "A String", # Default gateway address.
           "networkAdapters": { # List of network adapters. # List of network adapters.
+            "entries": [ # Network adapter entries.
+              { # Details of network adapter.
+                "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+                "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                  "addresses": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                },
+                "macAddress": "A String", # MAC address.
+              },
+            ],
             "networkAdapters": [ # Network adapter descriptions.
               { # Details of network adapter.
                 "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -3491,6 +4018,15 @@ 
Method Details

                       "subnetMask": "A String", # Subnet mask.
                     },
                   ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
                 },
                 "macAddress": "A String", # MAC address.
               },
@@ -3524,7 +4060,10 @@ 
Method Details

             "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
             "esxVersion": "A String", # ESX version.
             "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+            "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+            "vcenterUri": "A String", # vCenter URI used in collection.
             "vcenterVersion": "A String", # vCenter version.
+            "vcenterVmId": "A String", # vCenter VM ID.
           },
         },
         "powerState": "A String", # Power state of the machine.
@@ -3659,12 +4198,17 @@ 
Method Details

               "enabled": True or False, # Is SELinux enabled.
               "mode": "A String", # SELinux mode enforcing / permissive.
             },
+            "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
           },
+          "family": "A String", # What family the OS belong to, if known.
+          "osName": "A String", # The name of the operating system.
           "runtime": { # Guest OS runtime information. # Runtime information.
             "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
             "installedApps": { # Guest installed application list. # Installed applications information.
               "entries": [ # Application entries.
                 { # Guest installed application information.
+                  "applicationName": "A String", # Installed application name.
+                  "installTime": "A String", # The time when the application was installed.
                   "licenses": [ # License strings associated with the installed application.
                     "A String",
                   ],
@@ -3676,6 +4220,7 @@ 
Method Details

                 },
               ],
             },
+            "lastBootTime": "A String", # Last time the OS was booted.
             "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
               "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
               "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -3712,6 +4257,8 @@ 
Method Details

                 "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                 "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
               },
+              "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+              "scanTime": "A String", # Time of the last network scan.
             },
             "openFileList": { # Open file list. # Open files information.
               "entries": [ # Open file details entries.
@@ -3724,6 +4271,17 @@ 
Method Details

               ],
             },
             "processes": { # List of running guest OS processes. # Running processes.
+              "entries": [ # Running process entries.
+                { # Guest OS running process details.
+                  "attributes": { # Process extended attributes.
+                    "a_key": "A String",
+                  },
+                  "cmdline": "A String", # Process full command line.
+                  "exePath": "A String", # Process binary path.
+                  "pid": "A String", # Process ID.
+                  "user": "A String", # User running the process.
+                },
+              ],
               "processes": [ # Running process entries.
                 { # Guest OS running process details.
                   "attributes": { # Process extended attributes.
@@ -3737,12 +4295,25 @@ 
Method Details

               ],
             },
             "services": { # List of running guest OS services. # Running background services.
+              "entries": [ # Running service entries.
+                { # Guest OS running service details.
+                  "cmdline": "A String", # Service command line.
+                  "exePath": "A String", # Service binary path.
+                  "name": "A String", # Service name.
+                  "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
+                  "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                  "state": "A String", # Service state (raw, OS-agnostic).
+                  "status": "A String", # Service status.
+                },
+              ],
               "services": [ # Running service entries.
                 { # Guest OS running service details.
                   "cmdline": "A String", # Service command line.
                   "exePath": "A String", # Service binary path.
                   "name": "A String", # Service name.
                   "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
                   "startMode": "A String", # Service start mode (raw, OS-agnostic).
                   "state": "A String", # Service state (raw, OS-agnostic).
                   "status": "A String", # Service status.
@@ -3750,6 +4321,7 @@ 
Method Details

               ],
             },
           },
+          "version": "A String", # The version of the operating system.
         },
         "memoryMb": 42, # The amount of memory in the VirtualMachine. Must be non-negative.
         "osFamily": "A String", # What family the OS belong to, if known.
@@ -3779,7 +4351,10 @@ 
Method Details

             "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
             "esxVersion": "A String", # ESX version.
             "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+            "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+            "vcenterUri": "A String", # vCenter URI used in collection.
             "vcenterVersion": "A String", # vCenter version.
+            "vcenterVmId": "A String", # vCenter VM ID.
           },
         },
         "powerState": "A String", # Power state of VM (poweredOn or poweredOff).
@@ -3792,7 +4367,11 @@ 
Method Details

             "biosName": "A String", # BIOS name.
             "biosReleaseDate": "A String", # BIOS release date.
             "biosVersion": "A String", # BIOS version.
+            "id": "A String", # BIOS ID.
+            "manufacturer": "A String", # BIOS manufacturer.
+            "releaseTime": "A String", # BIOS release date.
             "smbiosUuid": "A String", # SMBIOS UUID.
+            "version": "A String", # BIOS version.
           },
           "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
           "cpuManufacturer": "A String", # CPU manufacturer, e.g., "Intel", "AMD".
@@ -3807,8 +4386,10 @@ 
Method Details

           "disks": { # VM disks. # List of disks.
             "entries": [ # Disk entries.
               { # Single disk entry.
+                "capacityBytes": "A String", # Disk capacity.
                 "diskLabel": "A String", # Disk label.
                 "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+                "freeSpaceBytes": "A String", # Disk free space.
                 "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
                 "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
                 "partitions": { # Disk partition list. # Partition layout.
@@ -3838,6 +4419,32 @@ 
Method Details

         "vmNetwork": { # Details of network adapters and settings. # VM network details.
           "defaultGw": "A String", # Default gateway address.
           "networkAdapters": { # List of network adapters. # List of network adapters.
+            "entries": [ # Network adapter entries.
+              { # Details of network adapter.
+                "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+                "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                  "addresses": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                },
+                "macAddress": "A String", # MAC address.
+              },
+            ],
             "networkAdapters": [ # Network adapter descriptions.
               { # Details of network adapter.
                 "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -3851,6 +4458,15 @@ 
Method Details

                       "subnetMask": "A String", # Subnet mask.
                     },
                   ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
                 },
                 "macAddress": "A String", # MAC address.
               },
@@ -4201,7 +4817,11 @@ 
Method Details

         "biosName": "A String", # BIOS name.
         "biosReleaseDate": "A String", # BIOS release date.
         "biosVersion": "A String", # BIOS version.
+        "id": "A String", # BIOS ID.
+        "manufacturer": "A String", # BIOS manufacturer.
+        "releaseTime": "A String", # BIOS release date.
         "smbiosUuid": "A String", # SMBIOS UUID.
+        "version": "A String", # BIOS version.
       },
       "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
       "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD".
@@ -4234,8 +4854,10 @@ 
Method Details

       "disks": { # VM disks. # List of disks.
         "entries": [ # Disk entries.
           { # Single disk entry.
+            "capacityBytes": "A String", # Disk capacity.
             "diskLabel": "A String", # Disk label.
             "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+            "freeSpaceBytes": "A String", # Disk free space.
             "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
             "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
             "partitions": { # Disk partition list. # Partition layout.
@@ -4300,12 +4922,17 @@ 
Method Details

           "enabled": True or False, # Is SELinux enabled.
           "mode": "A String", # SELinux mode enforcing / permissive.
         },
+        "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
       },
+      "family": "A String", # What family the OS belong to, if known.
+      "osName": "A String", # The name of the operating system.
       "runtime": { # Guest OS runtime information. # Runtime information.
         "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
         "installedApps": { # Guest installed application list. # Installed applications information.
           "entries": [ # Application entries.
             { # Guest installed application information.
+              "applicationName": "A String", # Installed application name.
+              "installTime": "A String", # The time when the application was installed.
               "licenses": [ # License strings associated with the installed application.
                 "A String",
               ],
@@ -4317,6 +4944,7 @@ 
Method Details

             },
           ],
         },
+        "lastBootTime": "A String", # Last time the OS was booted.
         "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
           "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
           "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -4353,6 +4981,8 @@ 
Method Details

             "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
             "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
           },
+          "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+          "scanTime": "A String", # Time of the last network scan.
         },
         "openFileList": { # Open file list. # Open files information.
           "entries": [ # Open file details entries.
@@ -4365,6 +4995,17 @@ 
Method Details

           ],
         },
         "processes": { # List of running guest OS processes. # Running processes.
+          "entries": [ # Running process entries.
+            { # Guest OS running process details.
+              "attributes": { # Process extended attributes.
+                "a_key": "A String",
+              },
+              "cmdline": "A String", # Process full command line.
+              "exePath": "A String", # Process binary path.
+              "pid": "A String", # Process ID.
+              "user": "A String", # User running the process.
+            },
+          ],
           "processes": [ # Running process entries.
             { # Guest OS running process details.
               "attributes": { # Process extended attributes.
@@ -4378,12 +5019,25 @@ 
Method Details

           ],
         },
         "services": { # List of running guest OS services. # Running background services.
+          "entries": [ # Running service entries.
+            { # Guest OS running service details.
+              "cmdline": "A String", # Service command line.
+              "exePath": "A String", # Service binary path.
+              "name": "A String", # Service name.
+              "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
+              "startMode": "A String", # Service start mode (raw, OS-agnostic).
+              "state": "A String", # Service state (raw, OS-agnostic).
+              "status": "A String", # Service status.
+            },
+          ],
           "services": [ # Running service entries.
             { # Guest OS running service details.
               "cmdline": "A String", # Service command line.
               "exePath": "A String", # Service binary path.
               "name": "A String", # Service name.
               "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
               "startMode": "A String", # Service start mode (raw, OS-agnostic).
               "state": "A String", # Service state (raw, OS-agnostic).
               "status": "A String", # Service status.
@@ -4391,12 +5045,39 @@ 
Method Details

           ],
         },
       },
+      "version": "A String", # The version of the operating system.
     },
     "machineName": "A String", # Machine name.
     "memoryMb": 42, # The amount of memory in the machine. Must be non-negative.
     "network": { # Details of network adapters and settings. # Network details.
       "defaultGateway": "A String", # Default gateway address.
       "networkAdapters": { # List of network adapters. # List of network adapters.
+        "entries": [ # Network adapter entries.
+          { # Details of network adapter.
+            "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+            "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+              "addresses": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+            },
+            "macAddress": "A String", # MAC address.
+          },
+        ],
         "networkAdapters": [ # Network adapter descriptions.
           { # Details of network adapter.
             "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -4410,6 +5091,15 @@ 
Method Details

                   "subnetMask": "A String", # Subnet mask.
                 },
               ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
             },
             "macAddress": "A String", # MAC address.
           },
@@ -4443,7 +5133,10 @@ 
Method Details

         "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
         "esxVersion": "A String", # ESX version.
         "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+        "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+        "vcenterUri": "A String", # vCenter URI used in collection.
         "vcenterVersion": "A String", # vCenter version.
+        "vcenterVmId": "A String", # vCenter VM ID.
       },
     },
     "powerState": "A String", # Power state of the machine.
@@ -4578,12 +5271,17 @@ 
Method Details

           "enabled": True or False, # Is SELinux enabled.
           "mode": "A String", # SELinux mode enforcing / permissive.
         },
+        "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
       },
+      "family": "A String", # What family the OS belong to, if known.
+      "osName": "A String", # The name of the operating system.
       "runtime": { # Guest OS runtime information. # Runtime information.
         "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
         "installedApps": { # Guest installed application list. # Installed applications information.
           "entries": [ # Application entries.
             { # Guest installed application information.
+              "applicationName": "A String", # Installed application name.
+              "installTime": "A String", # The time when the application was installed.
               "licenses": [ # License strings associated with the installed application.
                 "A String",
               ],
@@ -4595,6 +5293,7 @@ 
Method Details

             },
           ],
         },
+        "lastBootTime": "A String", # Last time the OS was booted.
         "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
           "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
           "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -4631,6 +5330,8 @@ 
Method Details

             "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
             "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
           },
+          "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+          "scanTime": "A String", # Time of the last network scan.
         },
         "openFileList": { # Open file list. # Open files information.
           "entries": [ # Open file details entries.
@@ -4643,6 +5344,17 @@ 
Method Details

           ],
         },
         "processes": { # List of running guest OS processes. # Running processes.
+          "entries": [ # Running process entries.
+            { # Guest OS running process details.
+              "attributes": { # Process extended attributes.
+                "a_key": "A String",
+              },
+              "cmdline": "A String", # Process full command line.
+              "exePath": "A String", # Process binary path.
+              "pid": "A String", # Process ID.
+              "user": "A String", # User running the process.
+            },
+          ],
           "processes": [ # Running process entries.
             { # Guest OS running process details.
               "attributes": { # Process extended attributes.
@@ -4656,12 +5368,25 @@ 
Method Details

           ],
         },
         "services": { # List of running guest OS services. # Running background services.
+          "entries": [ # Running service entries.
+            { # Guest OS running service details.
+              "cmdline": "A String", # Service command line.
+              "exePath": "A String", # Service binary path.
+              "name": "A String", # Service name.
+              "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
+              "startMode": "A String", # Service start mode (raw, OS-agnostic).
+              "state": "A String", # Service state (raw, OS-agnostic).
+              "status": "A String", # Service status.
+            },
+          ],
           "services": [ # Running service entries.
             { # Guest OS running service details.
               "cmdline": "A String", # Service command line.
               "exePath": "A String", # Service binary path.
               "name": "A String", # Service name.
               "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
               "startMode": "A String", # Service start mode (raw, OS-agnostic).
               "state": "A String", # Service state (raw, OS-agnostic).
               "status": "A String", # Service status.
@@ -4669,6 +5394,7 @@ 
Method Details

           ],
         },
       },
+      "version": "A String", # The version of the operating system.
     },
     "memoryMb": 42, # The amount of memory in the VirtualMachine. Must be non-negative.
     "osFamily": "A String", # What family the OS belong to, if known.
@@ -4698,7 +5424,10 @@ 
Method Details

         "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
         "esxVersion": "A String", # ESX version.
         "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+        "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+        "vcenterUri": "A String", # vCenter URI used in collection.
         "vcenterVersion": "A String", # vCenter version.
+        "vcenterVmId": "A String", # vCenter VM ID.
       },
     },
     "powerState": "A String", # Power state of VM (poweredOn or poweredOff).
@@ -4711,7 +5440,11 @@ 
Method Details

         "biosName": "A String", # BIOS name.
         "biosReleaseDate": "A String", # BIOS release date.
         "biosVersion": "A String", # BIOS version.
+        "id": "A String", # BIOS ID.
+        "manufacturer": "A String", # BIOS manufacturer.
+        "releaseTime": "A String", # BIOS release date.
         "smbiosUuid": "A String", # SMBIOS UUID.
+        "version": "A String", # BIOS version.
       },
       "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
       "cpuManufacturer": "A String", # CPU manufacturer, e.g., "Intel", "AMD".
@@ -4726,8 +5459,10 @@ 
Method Details

       "disks": { # VM disks. # List of disks.
         "entries": [ # Disk entries.
           { # Single disk entry.
+            "capacityBytes": "A String", # Disk capacity.
             "diskLabel": "A String", # Disk label.
             "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+            "freeSpaceBytes": "A String", # Disk free space.
             "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
             "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
             "partitions": { # Disk partition list. # Partition layout.
@@ -4757,6 +5492,32 @@ 
Method Details

     "vmNetwork": { # Details of network adapters and settings. # VM network details.
       "defaultGw": "A String", # Default gateway address.
       "networkAdapters": { # List of network adapters. # List of network adapters.
+        "entries": [ # Network adapter entries.
+          { # Details of network adapter.
+            "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+            "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+              "addresses": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+            },
+            "macAddress": "A String", # MAC address.
+          },
+        ],
         "networkAdapters": [ # Network adapter descriptions.
           { # Details of network adapter.
             "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -4770,6 +5531,15 @@ 
Method Details

                   "subnetMask": "A String", # Subnet mask.
                 },
               ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
             },
             "macAddress": "A String", # MAC address.
           },
@@ -5100,7 +5870,11 @@ 
Method Details

         "biosName": "A String", # BIOS name.
         "biosReleaseDate": "A String", # BIOS release date.
         "biosVersion": "A String", # BIOS version.
+        "id": "A String", # BIOS ID.
+        "manufacturer": "A String", # BIOS manufacturer.
+        "releaseTime": "A String", # BIOS release date.
         "smbiosUuid": "A String", # SMBIOS UUID.
+        "version": "A String", # BIOS version.
       },
       "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
       "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD".
@@ -5133,8 +5907,10 @@ 
Method Details

       "disks": { # VM disks. # List of disks.
         "entries": [ # Disk entries.
           { # Single disk entry.
+            "capacityBytes": "A String", # Disk capacity.
             "diskLabel": "A String", # Disk label.
             "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+            "freeSpaceBytes": "A String", # Disk free space.
             "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
             "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
             "partitions": { # Disk partition list. # Partition layout.
@@ -5199,12 +5975,17 @@ 
Method Details

           "enabled": True or False, # Is SELinux enabled.
           "mode": "A String", # SELinux mode enforcing / permissive.
         },
+        "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
       },
+      "family": "A String", # What family the OS belong to, if known.
+      "osName": "A String", # The name of the operating system.
       "runtime": { # Guest OS runtime information. # Runtime information.
         "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
         "installedApps": { # Guest installed application list. # Installed applications information.
           "entries": [ # Application entries.
             { # Guest installed application information.
+              "applicationName": "A String", # Installed application name.
+              "installTime": "A String", # The time when the application was installed.
               "licenses": [ # License strings associated with the installed application.
                 "A String",
               ],
@@ -5216,6 +5997,7 @@ 
Method Details

             },
           ],
         },
+        "lastBootTime": "A String", # Last time the OS was booted.
         "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
           "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
           "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -5252,6 +6034,8 @@ 
Method Details

             "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
             "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
           },
+          "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+          "scanTime": "A String", # Time of the last network scan.
         },
         "openFileList": { # Open file list. # Open files information.
           "entries": [ # Open file details entries.
@@ -5264,6 +6048,17 @@ 
Method Details

           ],
         },
         "processes": { # List of running guest OS processes. # Running processes.
+          "entries": [ # Running process entries.
+            { # Guest OS running process details.
+              "attributes": { # Process extended attributes.
+                "a_key": "A String",
+              },
+              "cmdline": "A String", # Process full command line.
+              "exePath": "A String", # Process binary path.
+              "pid": "A String", # Process ID.
+              "user": "A String", # User running the process.
+            },
+          ],
           "processes": [ # Running process entries.
             { # Guest OS running process details.
               "attributes": { # Process extended attributes.
@@ -5277,12 +6072,25 @@ 
Method Details

           ],
         },
         "services": { # List of running guest OS services. # Running background services.
+          "entries": [ # Running service entries.
+            { # Guest OS running service details.
+              "cmdline": "A String", # Service command line.
+              "exePath": "A String", # Service binary path.
+              "name": "A String", # Service name.
+              "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
+              "startMode": "A String", # Service start mode (raw, OS-agnostic).
+              "state": "A String", # Service state (raw, OS-agnostic).
+              "status": "A String", # Service status.
+            },
+          ],
           "services": [ # Running service entries.
             { # Guest OS running service details.
               "cmdline": "A String", # Service command line.
               "exePath": "A String", # Service binary path.
               "name": "A String", # Service name.
               "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
               "startMode": "A String", # Service start mode (raw, OS-agnostic).
               "state": "A String", # Service state (raw, OS-agnostic).
               "status": "A String", # Service status.
@@ -5290,12 +6098,39 @@ 
Method Details

           ],
         },
       },
+      "version": "A String", # The version of the operating system.
     },
     "machineName": "A String", # Machine name.
     "memoryMb": 42, # The amount of memory in the machine. Must be non-negative.
     "network": { # Details of network adapters and settings. # Network details.
       "defaultGateway": "A String", # Default gateway address.
       "networkAdapters": { # List of network adapters. # List of network adapters.
+        "entries": [ # Network adapter entries.
+          { # Details of network adapter.
+            "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+            "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+              "addresses": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+            },
+            "macAddress": "A String", # MAC address.
+          },
+        ],
         "networkAdapters": [ # Network adapter descriptions.
           { # Details of network adapter.
             "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -5309,6 +6144,15 @@ 
Method Details

                   "subnetMask": "A String", # Subnet mask.
                 },
               ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
             },
             "macAddress": "A String", # MAC address.
           },
@@ -5342,7 +6186,10 @@ 
Method Details

         "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
         "esxVersion": "A String", # ESX version.
         "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+        "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+        "vcenterUri": "A String", # vCenter URI used in collection.
         "vcenterVersion": "A String", # vCenter version.
+        "vcenterVmId": "A String", # vCenter VM ID.
       },
     },
     "powerState": "A String", # Power state of the machine.
@@ -5477,12 +6324,17 @@ 
Method Details

           "enabled": True or False, # Is SELinux enabled.
           "mode": "A String", # SELinux mode enforcing / permissive.
         },
+        "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
       },
+      "family": "A String", # What family the OS belong to, if known.
+      "osName": "A String", # The name of the operating system.
       "runtime": { # Guest OS runtime information. # Runtime information.
         "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
         "installedApps": { # Guest installed application list. # Installed applications information.
           "entries": [ # Application entries.
             { # Guest installed application information.
+              "applicationName": "A String", # Installed application name.
+              "installTime": "A String", # The time when the application was installed.
               "licenses": [ # License strings associated with the installed application.
                 "A String",
               ],
@@ -5494,6 +6346,7 @@ 
Method Details

             },
           ],
         },
+        "lastBootTime": "A String", # Last time the OS was booted.
         "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
           "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
           "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -5530,6 +6383,8 @@ 
Method Details

             "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
             "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
           },
+          "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+          "scanTime": "A String", # Time of the last network scan.
         },
         "openFileList": { # Open file list. # Open files information.
           "entries": [ # Open file details entries.
@@ -5542,6 +6397,17 @@ 
Method Details

           ],
         },
         "processes": { # List of running guest OS processes. # Running processes.
+          "entries": [ # Running process entries.
+            { # Guest OS running process details.
+              "attributes": { # Process extended attributes.
+                "a_key": "A String",
+              },
+              "cmdline": "A String", # Process full command line.
+              "exePath": "A String", # Process binary path.
+              "pid": "A String", # Process ID.
+              "user": "A String", # User running the process.
+            },
+          ],
           "processes": [ # Running process entries.
             { # Guest OS running process details.
               "attributes": { # Process extended attributes.
@@ -5555,12 +6421,25 @@ 
Method Details

           ],
         },
         "services": { # List of running guest OS services. # Running background services.
+          "entries": [ # Running service entries.
+            { # Guest OS running service details.
+              "cmdline": "A String", # Service command line.
+              "exePath": "A String", # Service binary path.
+              "name": "A String", # Service name.
+              "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
+              "startMode": "A String", # Service start mode (raw, OS-agnostic).
+              "state": "A String", # Service state (raw, OS-agnostic).
+              "status": "A String", # Service status.
+            },
+          ],
           "services": [ # Running service entries.
             { # Guest OS running service details.
               "cmdline": "A String", # Service command line.
               "exePath": "A String", # Service binary path.
               "name": "A String", # Service name.
               "pid": "A String", # Service pid.
+              "serviceName": "A String", # Service name.
               "startMode": "A String", # Service start mode (raw, OS-agnostic).
               "state": "A String", # Service state (raw, OS-agnostic).
               "status": "A String", # Service status.
@@ -5568,6 +6447,7 @@ 
Method Details

           ],
         },
       },
+      "version": "A String", # The version of the operating system.
     },
     "memoryMb": 42, # The amount of memory in the VirtualMachine. Must be non-negative.
     "osFamily": "A String", # What family the OS belong to, if known.
@@ -5597,7 +6477,10 @@ 
Method Details

         "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
         "esxVersion": "A String", # ESX version.
         "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+        "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+        "vcenterUri": "A String", # vCenter URI used in collection.
         "vcenterVersion": "A String", # vCenter version.
+        "vcenterVmId": "A String", # vCenter VM ID.
       },
     },
     "powerState": "A String", # Power state of VM (poweredOn or poweredOff).
@@ -5610,7 +6493,11 @@ 
Method Details

         "biosName": "A String", # BIOS name.
         "biosReleaseDate": "A String", # BIOS release date.
         "biosVersion": "A String", # BIOS version.
+        "id": "A String", # BIOS ID.
+        "manufacturer": "A String", # BIOS manufacturer.
+        "releaseTime": "A String", # BIOS release date.
         "smbiosUuid": "A String", # SMBIOS UUID.
+        "version": "A String", # BIOS version.
       },
       "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
       "cpuManufacturer": "A String", # CPU manufacturer, e.g., "Intel", "AMD".
@@ -5625,8 +6512,10 @@ 
Method Details

       "disks": { # VM disks. # List of disks.
         "entries": [ # Disk entries.
           { # Single disk entry.
+            "capacityBytes": "A String", # Disk capacity.
             "diskLabel": "A String", # Disk label.
             "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+            "freeSpaceBytes": "A String", # Disk free space.
             "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
             "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
             "partitions": { # Disk partition list. # Partition layout.
@@ -5656,6 +6545,32 @@ 
Method Details

     "vmNetwork": { # Details of network adapters and settings. # VM network details.
       "defaultGw": "A String", # Default gateway address.
       "networkAdapters": { # List of network adapters. # List of network adapters.
+        "entries": [ # Network adapter entries.
+          { # Details of network adapter.
+            "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+            "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+              "addresses": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
+            },
+            "macAddress": "A String", # MAC address.
+          },
+        ],
         "networkAdapters": [ # Network adapter descriptions.
           { # Details of network adapter.
             "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -5669,6 +6584,15 @@ 
Method Details

                   "subnetMask": "A String", # Subnet mask.
                 },
               ],
+              "entries": [ # Network address entries.
+                { # Details of network address.
+                  "assignment": "A String", # Whether DHCP is used to assign addresses.
+                  "bcast": "A String", # Broadcast address.
+                  "fqdn": "A String", # Fully qualified domain name.
+                  "ipAddress": "A String", # Assigned or configured IP Address.
+                  "subnetMask": "A String", # Subnet mask.
+                },
+              ],
             },
             "macAddress": "A String", # MAC address.
           },
@@ -5894,7 +6818,11 @@ 
Method Details

             "biosName": "A String", # BIOS name.
             "biosReleaseDate": "A String", # BIOS release date.
             "biosVersion": "A String", # BIOS version.
+            "id": "A String", # BIOS ID.
+            "manufacturer": "A String", # BIOS manufacturer.
+            "releaseTime": "A String", # BIOS release date.
             "smbiosUuid": "A String", # SMBIOS UUID.
+            "version": "A String", # BIOS version.
           },
           "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
           "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD".
@@ -5927,8 +6855,10 @@ 
Method Details

           "disks": { # VM disks. # List of disks.
             "entries": [ # Disk entries.
               { # Single disk entry.
+                "capacityBytes": "A String", # Disk capacity.
                 "diskLabel": "A String", # Disk label.
                 "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+                "freeSpaceBytes": "A String", # Disk free space.
                 "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
                 "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
                 "partitions": { # Disk partition list. # Partition layout.
@@ -5993,12 +6923,17 @@ 
Method Details

               "enabled": True or False, # Is SELinux enabled.
               "mode": "A String", # SELinux mode enforcing / permissive.
             },
+            "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
           },
+          "family": "A String", # What family the OS belong to, if known.
+          "osName": "A String", # The name of the operating system.
           "runtime": { # Guest OS runtime information. # Runtime information.
             "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
             "installedApps": { # Guest installed application list. # Installed applications information.
               "entries": [ # Application entries.
                 { # Guest installed application information.
+                  "applicationName": "A String", # Installed application name.
+                  "installTime": "A String", # The time when the application was installed.
                   "licenses": [ # License strings associated with the installed application.
                     "A String",
                   ],
@@ -6010,6 +6945,7 @@ 
Method Details

                 },
               ],
             },
+            "lastBootTime": "A String", # Last time the OS was booted.
             "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
               "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
               "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -6046,6 +6982,8 @@ 
Method Details

                 "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                 "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
               },
+              "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+              "scanTime": "A String", # Time of the last network scan.
             },
             "openFileList": { # Open file list. # Open files information.
               "entries": [ # Open file details entries.
@@ -6058,6 +6996,17 @@ 
Method Details

               ],
             },
             "processes": { # List of running guest OS processes. # Running processes.
+              "entries": [ # Running process entries.
+                { # Guest OS running process details.
+                  "attributes": { # Process extended attributes.
+                    "a_key": "A String",
+                  },
+                  "cmdline": "A String", # Process full command line.
+                  "exePath": "A String", # Process binary path.
+                  "pid": "A String", # Process ID.
+                  "user": "A String", # User running the process.
+                },
+              ],
               "processes": [ # Running process entries.
                 { # Guest OS running process details.
                   "attributes": { # Process extended attributes.
@@ -6071,12 +7020,25 @@ 
Method Details

               ],
             },
             "services": { # List of running guest OS services. # Running background services.
+              "entries": [ # Running service entries.
+                { # Guest OS running service details.
+                  "cmdline": "A String", # Service command line.
+                  "exePath": "A String", # Service binary path.
+                  "name": "A String", # Service name.
+                  "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
+                  "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                  "state": "A String", # Service state (raw, OS-agnostic).
+                  "status": "A String", # Service status.
+                },
+              ],
               "services": [ # Running service entries.
                 { # Guest OS running service details.
                   "cmdline": "A String", # Service command line.
                   "exePath": "A String", # Service binary path.
                   "name": "A String", # Service name.
                   "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
                   "startMode": "A String", # Service start mode (raw, OS-agnostic).
                   "state": "A String", # Service state (raw, OS-agnostic).
                   "status": "A String", # Service status.
@@ -6084,12 +7046,39 @@ 
Method Details

               ],
             },
           },
+          "version": "A String", # The version of the operating system.
         },
         "machineName": "A String", # Machine name.
         "memoryMb": 42, # The amount of memory in the machine. Must be non-negative.
         "network": { # Details of network adapters and settings. # Network details.
           "defaultGateway": "A String", # Default gateway address.
           "networkAdapters": { # List of network adapters. # List of network adapters.
+            "entries": [ # Network adapter entries.
+              { # Details of network adapter.
+                "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+                "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                  "addresses": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                },
+                "macAddress": "A String", # MAC address.
+              },
+            ],
             "networkAdapters": [ # Network adapter descriptions.
               { # Details of network adapter.
                 "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -6103,6 +7092,15 @@ 
Method Details

                       "subnetMask": "A String", # Subnet mask.
                     },
                   ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
                 },
                 "macAddress": "A String", # MAC address.
               },
@@ -6136,7 +7134,10 @@ 
Method Details

             "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
             "esxVersion": "A String", # ESX version.
             "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+            "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+            "vcenterUri": "A String", # vCenter URI used in collection.
             "vcenterVersion": "A String", # vCenter version.
+            "vcenterVmId": "A String", # vCenter VM ID.
           },
         },
         "powerState": "A String", # Power state of the machine.
@@ -6226,12 +7227,17 @@ 
Method Details

               "enabled": True or False, # Is SELinux enabled.
               "mode": "A String", # SELinux mode enforcing / permissive.
             },
+            "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
           },
+          "family": "A String", # What family the OS belong to, if known.
+          "osName": "A String", # The name of the operating system.
           "runtime": { # Guest OS runtime information. # Runtime information.
             "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
             "installedApps": { # Guest installed application list. # Installed applications information.
               "entries": [ # Application entries.
                 { # Guest installed application information.
+                  "applicationName": "A String", # Installed application name.
+                  "installTime": "A String", # The time when the application was installed.
                   "licenses": [ # License strings associated with the installed application.
                     "A String",
                   ],
@@ -6243,6 +7249,7 @@ 
Method Details

                 },
               ],
             },
+            "lastBootTime": "A String", # Last time the OS was booted.
             "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
               "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
               "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -6279,6 +7286,8 @@ 
Method Details

                 "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                 "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
               },
+              "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+              "scanTime": "A String", # Time of the last network scan.
             },
             "openFileList": { # Open file list. # Open files information.
               "entries": [ # Open file details entries.
@@ -6291,6 +7300,17 @@ 
Method Details

               ],
             },
             "processes": { # List of running guest OS processes. # Running processes.
+              "entries": [ # Running process entries.
+                { # Guest OS running process details.
+                  "attributes": { # Process extended attributes.
+                    "a_key": "A String",
+                  },
+                  "cmdline": "A String", # Process full command line.
+                  "exePath": "A String", # Process binary path.
+                  "pid": "A String", # Process ID.
+                  "user": "A String", # User running the process.
+                },
+              ],
               "processes": [ # Running process entries.
                 { # Guest OS running process details.
                   "attributes": { # Process extended attributes.
@@ -6304,12 +7324,25 @@ 
Method Details

               ],
             },
             "services": { # List of running guest OS services. # Running background services.
+              "entries": [ # Running service entries.
+                { # Guest OS running service details.
+                  "cmdline": "A String", # Service command line.
+                  "exePath": "A String", # Service binary path.
+                  "name": "A String", # Service name.
+                  "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
+                  "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                  "state": "A String", # Service state (raw, OS-agnostic).
+                  "status": "A String", # Service status.
+                },
+              ],
               "services": [ # Running service entries.
                 { # Guest OS running service details.
                   "cmdline": "A String", # Service command line.
                   "exePath": "A String", # Service binary path.
                   "name": "A String", # Service name.
                   "pid": "A String", # Service pid.
+                  "serviceName": "A String", # Service name.
                   "startMode": "A String", # Service start mode (raw, OS-agnostic).
                   "state": "A String", # Service state (raw, OS-agnostic).
                   "status": "A String", # Service status.
@@ -6317,6 +7350,7 @@ 
Method Details

               ],
             },
           },
+          "version": "A String", # The version of the operating system.
         },
         "memoryMb": 42, # The amount of memory in the VirtualMachine. Must be non-negative.
         "osFamily": "A String", # What family the OS belong to, if known.
@@ -6346,7 +7380,10 @@ 
Method Details

             "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
             "esxVersion": "A String", # ESX version.
             "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+            "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+            "vcenterUri": "A String", # vCenter URI used in collection.
             "vcenterVersion": "A String", # vCenter version.
+            "vcenterVmId": "A String", # vCenter VM ID.
           },
         },
         "powerState": "A String", # Power state of VM (poweredOn or poweredOff).
@@ -6359,7 +7396,11 @@ 
Method Details

             "biosName": "A String", # BIOS name.
             "biosReleaseDate": "A String", # BIOS release date.
             "biosVersion": "A String", # BIOS version.
+            "id": "A String", # BIOS ID.
+            "manufacturer": "A String", # BIOS manufacturer.
+            "releaseTime": "A String", # BIOS release date.
             "smbiosUuid": "A String", # SMBIOS UUID.
+            "version": "A String", # BIOS version.
           },
           "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
           "cpuManufacturer": "A String", # CPU manufacturer, e.g., "Intel", "AMD".
@@ -6374,8 +7415,10 @@ 
Method Details

           "disks": { # VM disks. # List of disks.
             "entries": [ # Disk entries.
               { # Single disk entry.
+                "capacityBytes": "A String", # Disk capacity.
                 "diskLabel": "A String", # Disk label.
                 "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+                "freeSpaceBytes": "A String", # Disk free space.
                 "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
                 "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
                 "partitions": { # Disk partition list. # Partition layout.
@@ -6405,6 +7448,32 @@ 
Method Details

         "vmNetwork": { # Details of network adapters and settings. # VM network details.
           "defaultGw": "A String", # Default gateway address.
           "networkAdapters": { # List of network adapters. # List of network adapters.
+            "entries": [ # Network adapter entries.
+              { # Details of network adapter.
+                "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+                "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                  "addresses": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
+                },
+                "macAddress": "A String", # MAC address.
+              },
+            ],
             "networkAdapters": [ # Network adapter descriptions.
               { # Details of network adapter.
                 "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -6418,6 +7487,15 @@ 
Method Details

                       "subnetMask": "A String", # Subnet mask.
                     },
                   ],
+                  "entries": [ # Network address entries.
+                    { # Details of network address.
+                      "assignment": "A String", # Whether DHCP is used to assign addresses.
+                      "bcast": "A String", # Broadcast address.
+                      "fqdn": "A String", # Fully qualified domain name.
+                      "ipAddress": "A String", # Assigned or configured IP Address.
+                      "subnetMask": "A String", # Subnet mask.
+                    },
+                  ],
                 },
                 "macAddress": "A String", # MAC address.
               },
diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html
index 7ed385289be..edfc2264989 100644
--- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html
+++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html
@@ -375,7 +375,7 @@ 
Method Details

             "displayName": "A String", # Display Name of the Preference Set
             "machineFinding": { # A set of findings that applies to assets of type Virtual/Physical Machine. # Output only. A set of findings that applies to all virtual machines in the input. Only present for virtual machines.
               "allocatedAssetCount": "A String", # Count of assets which were allocated.
-              "allocatedDiskTypes": [ # Set of disk types allocated to assets.
+              "allocatedDiskTypes": [ # @deprecated. Use storage_allocations instead. Set of disk types allocated to assets.
                 "A String",
               ],
               "allocatedRegions": [ # Set of regions in which the assets were allocated.
@@ -1158,7 +1158,7 @@ 
Method Details

             "displayName": "A String", # Display Name of the Preference Set
             "machineFinding": { # A set of findings that applies to assets of type Virtual/Physical Machine. # Output only. A set of findings that applies to all virtual machines in the input. Only present for virtual machines.
               "allocatedAssetCount": "A String", # Count of assets which were allocated.
-              "allocatedDiskTypes": [ # Set of disk types allocated to assets.
+              "allocatedDiskTypes": [ # @deprecated. Use storage_allocations instead. Set of disk types allocated to assets.
                 "A String",
               ],
               "allocatedRegions": [ # Set of regions in which the assets were allocated.
@@ -1882,7 +1882,7 @@ 
Method Details

                 "displayName": "A String", # Display Name of the Preference Set
                 "machineFinding": { # A set of findings that applies to assets of type Virtual/Physical Machine. # Output only. A set of findings that applies to all virtual machines in the input. Only present for virtual machines.
                   "allocatedAssetCount": "A String", # Count of assets which were allocated.
-                  "allocatedDiskTypes": [ # Set of disk types allocated to assets.
+                  "allocatedDiskTypes": [ # @deprecated. Use storage_allocations instead. Set of disk types allocated to assets.
                     "A String",
                   ],
                   "allocatedRegions": [ # Set of regions in which the assets were allocated.
diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html
index 873ca1eac64..785b6131925 100644
--- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html
+++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.sources.errorFrames.html
@@ -314,7 +314,11 @@ 
Method Details

           "biosName": "A String", # BIOS name.
           "biosReleaseDate": "A String", # BIOS release date.
           "biosVersion": "A String", # BIOS version.
+          "id": "A String", # BIOS ID.
+          "manufacturer": "A String", # BIOS manufacturer.
+          "releaseTime": "A String", # BIOS release date.
           "smbiosUuid": "A String", # SMBIOS UUID.
+          "version": "A String", # BIOS version.
         },
         "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
         "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD".
@@ -347,8 +351,10 @@ 
Method Details

         "disks": { # VM disks. # List of disks.
           "entries": [ # Disk entries.
             { # Single disk entry.
+              "capacityBytes": "A String", # Disk capacity.
               "diskLabel": "A String", # Disk label.
               "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+              "freeSpaceBytes": "A String", # Disk free space.
               "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
               "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
               "partitions": { # Disk partition list. # Partition layout.
@@ -413,12 +419,17 @@ 
Method Details

             "enabled": True or False, # Is SELinux enabled.
             "mode": "A String", # SELinux mode enforcing / permissive.
           },
+          "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
         },
+        "family": "A String", # What family the OS belong to, if known.
+        "osName": "A String", # The name of the operating system.
         "runtime": { # Guest OS runtime information. # Runtime information.
           "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
           "installedApps": { # Guest installed application list. # Installed applications information.
             "entries": [ # Application entries.
               { # Guest installed application information.
+                "applicationName": "A String", # Installed application name.
+                "installTime": "A String", # The time when the application was installed.
                 "licenses": [ # License strings associated with the installed application.
                   "A String",
                 ],
@@ -430,6 +441,7 @@ 
Method Details

               },
             ],
           },
+          "lastBootTime": "A String", # Last time the OS was booted.
           "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
             "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
             "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -466,6 +478,8 @@ 
Method Details

               "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
               "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
             },
+            "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+            "scanTime": "A String", # Time of the last network scan.
           },
           "openFileList": { # Open file list. # Open files information.
             "entries": [ # Open file details entries.
@@ -478,6 +492,17 @@ 
Method Details

             ],
           },
           "processes": { # List of running guest OS processes. # Running processes.
+            "entries": [ # Running process entries.
+              { # Guest OS running process details.
+                "attributes": { # Process extended attributes.
+                  "a_key": "A String",
+                },
+                "cmdline": "A String", # Process full command line.
+                "exePath": "A String", # Process binary path.
+                "pid": "A String", # Process ID.
+                "user": "A String", # User running the process.
+              },
+            ],
             "processes": [ # Running process entries.
               { # Guest OS running process details.
                 "attributes": { # Process extended attributes.
@@ -491,12 +516,25 @@ 
Method Details

             ],
           },
           "services": { # List of running guest OS services. # Running background services.
+            "entries": [ # Running service entries.
+              { # Guest OS running service details.
+                "cmdline": "A String", # Service command line.
+                "exePath": "A String", # Service binary path.
+                "name": "A String", # Service name.
+                "pid": "A String", # Service pid.
+                "serviceName": "A String", # Service name.
+                "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                "state": "A String", # Service state (raw, OS-agnostic).
+                "status": "A String", # Service status.
+              },
+            ],
             "services": [ # Running service entries.
               { # Guest OS running service details.
                 "cmdline": "A String", # Service command line.
                 "exePath": "A String", # Service binary path.
                 "name": "A String", # Service name.
                 "pid": "A String", # Service pid.
+                "serviceName": "A String", # Service name.
                 "startMode": "A String", # Service start mode (raw, OS-agnostic).
                 "state": "A String", # Service state (raw, OS-agnostic).
                 "status": "A String", # Service status.
@@ -504,12 +542,39 @@ 
Method Details

             ],
           },
         },
+        "version": "A String", # The version of the operating system.
       },
       "machineName": "A String", # Machine name.
       "memoryMb": 42, # The amount of memory in the machine. Must be non-negative.
       "network": { # Details of network adapters and settings. # Network details.
         "defaultGateway": "A String", # Default gateway address.
         "networkAdapters": { # List of network adapters. # List of network adapters.
+          "entries": [ # Network adapter entries.
+            { # Details of network adapter.
+              "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+              "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                "addresses": [ # Network address entries.
+                  { # Details of network address.
+                    "assignment": "A String", # Whether DHCP is used to assign addresses.
+                    "bcast": "A String", # Broadcast address.
+                    "fqdn": "A String", # Fully qualified domain name.
+                    "ipAddress": "A String", # Assigned or configured IP Address.
+                    "subnetMask": "A String", # Subnet mask.
+                  },
+                ],
+                "entries": [ # Network address entries.
+                  { # Details of network address.
+                    "assignment": "A String", # Whether DHCP is used to assign addresses.
+                    "bcast": "A String", # Broadcast address.
+                    "fqdn": "A String", # Fully qualified domain name.
+                    "ipAddress": "A String", # Assigned or configured IP Address.
+                    "subnetMask": "A String", # Subnet mask.
+                  },
+                ],
+              },
+              "macAddress": "A String", # MAC address.
+            },
+          ],
           "networkAdapters": [ # Network adapter descriptions.
             { # Details of network adapter.
               "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -523,6 +588,15 @@ 
Method Details

                     "subnetMask": "A String", # Subnet mask.
                   },
                 ],
+                "entries": [ # Network address entries.
+                  { # Details of network address.
+                    "assignment": "A String", # Whether DHCP is used to assign addresses.
+                    "bcast": "A String", # Broadcast address.
+                    "fqdn": "A String", # Fully qualified domain name.
+                    "ipAddress": "A String", # Assigned or configured IP Address.
+                    "subnetMask": "A String", # Subnet mask.
+                  },
+                ],
               },
               "macAddress": "A String", # MAC address.
             },
@@ -556,7 +630,10 @@ 
Method Details

           "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
           "esxVersion": "A String", # ESX version.
           "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+          "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+          "vcenterUri": "A String", # vCenter URI used in collection.
           "vcenterVersion": "A String", # vCenter version.
+          "vcenterVmId": "A String", # vCenter VM ID.
         },
       },
       "powerState": "A String", # Power state of the machine.
@@ -646,12 +723,17 @@ 
Method Details

             "enabled": True or False, # Is SELinux enabled.
             "mode": "A String", # SELinux mode enforcing / permissive.
           },
+          "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
         },
+        "family": "A String", # What family the OS belong to, if known.
+        "osName": "A String", # The name of the operating system.
         "runtime": { # Guest OS runtime information. # Runtime information.
           "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
           "installedApps": { # Guest installed application list. # Installed applications information.
             "entries": [ # Application entries.
               { # Guest installed application information.
+                "applicationName": "A String", # Installed application name.
+                "installTime": "A String", # The time when the application was installed.
                 "licenses": [ # License strings associated with the installed application.
                   "A String",
                 ],
@@ -663,6 +745,7 @@ 
Method Details

               },
             ],
           },
+          "lastBootTime": "A String", # Last time the OS was booted.
           "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
             "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
             "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -699,6 +782,8 @@ 
Method Details

               "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
               "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
             },
+            "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+            "scanTime": "A String", # Time of the last network scan.
           },
           "openFileList": { # Open file list. # Open files information.
             "entries": [ # Open file details entries.
@@ -711,6 +796,17 @@ 
Method Details

             ],
           },
           "processes": { # List of running guest OS processes. # Running processes.
+            "entries": [ # Running process entries.
+              { # Guest OS running process details.
+                "attributes": { # Process extended attributes.
+                  "a_key": "A String",
+                },
+                "cmdline": "A String", # Process full command line.
+                "exePath": "A String", # Process binary path.
+                "pid": "A String", # Process ID.
+                "user": "A String", # User running the process.
+              },
+            ],
             "processes": [ # Running process entries.
               { # Guest OS running process details.
                 "attributes": { # Process extended attributes.
@@ -724,12 +820,25 @@ 
Method Details

             ],
           },
           "services": { # List of running guest OS services. # Running background services.
+            "entries": [ # Running service entries.
+              { # Guest OS running service details.
+                "cmdline": "A String", # Service command line.
+                "exePath": "A String", # Service binary path.
+                "name": "A String", # Service name.
+                "pid": "A String", # Service pid.
+                "serviceName": "A String", # Service name.
+                "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                "state": "A String", # Service state (raw, OS-agnostic).
+                "status": "A String", # Service status.
+              },
+            ],
             "services": [ # Running service entries.
               { # Guest OS running service details.
                 "cmdline": "A String", # Service command line.
                 "exePath": "A String", # Service binary path.
                 "name": "A String", # Service name.
                 "pid": "A String", # Service pid.
+                "serviceName": "A String", # Service name.
                 "startMode": "A String", # Service start mode (raw, OS-agnostic).
                 "state": "A String", # Service state (raw, OS-agnostic).
                 "status": "A String", # Service status.
@@ -737,6 +846,7 @@ 
Method Details

             ],
           },
         },
+        "version": "A String", # The version of the operating system.
       },
       "memoryMb": 42, # The amount of memory in the VirtualMachine. Must be non-negative.
       "osFamily": "A String", # What family the OS belong to, if known.
@@ -766,7 +876,10 @@ 
Method Details

           "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
           "esxVersion": "A String", # ESX version.
           "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+          "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+          "vcenterUri": "A String", # vCenter URI used in collection.
           "vcenterVersion": "A String", # vCenter version.
+          "vcenterVmId": "A String", # vCenter VM ID.
         },
       },
       "powerState": "A String", # Power state of VM (poweredOn or poweredOff).
@@ -779,7 +892,11 @@ 
Method Details

           "biosName": "A String", # BIOS name.
           "biosReleaseDate": "A String", # BIOS release date.
           "biosVersion": "A String", # BIOS version.
+          "id": "A String", # BIOS ID.
+          "manufacturer": "A String", # BIOS manufacturer.
+          "releaseTime": "A String", # BIOS release date.
           "smbiosUuid": "A String", # SMBIOS UUID.
+          "version": "A String", # BIOS version.
         },
         "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
         "cpuManufacturer": "A String", # CPU manufacturer, e.g., "Intel", "AMD".
@@ -794,8 +911,10 @@ 
Method Details

         "disks": { # VM disks. # List of disks.
           "entries": [ # Disk entries.
             { # Single disk entry.
+              "capacityBytes": "A String", # Disk capacity.
               "diskLabel": "A String", # Disk label.
               "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+              "freeSpaceBytes": "A String", # Disk free space.
               "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
               "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
               "partitions": { # Disk partition list. # Partition layout.
@@ -825,6 +944,32 @@ 
Method Details

       "vmNetwork": { # Details of network adapters and settings. # VM network details.
         "defaultGw": "A String", # Default gateway address.
         "networkAdapters": { # List of network adapters. # List of network adapters.
+          "entries": [ # Network adapter entries.
+            { # Details of network adapter.
+              "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+              "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                "addresses": [ # Network address entries.
+                  { # Details of network address.
+                    "assignment": "A String", # Whether DHCP is used to assign addresses.
+                    "bcast": "A String", # Broadcast address.
+                    "fqdn": "A String", # Fully qualified domain name.
+                    "ipAddress": "A String", # Assigned or configured IP Address.
+                    "subnetMask": "A String", # Subnet mask.
+                  },
+                ],
+                "entries": [ # Network address entries.
+                  { # Details of network address.
+                    "assignment": "A String", # Whether DHCP is used to assign addresses.
+                    "bcast": "A String", # Broadcast address.
+                    "fqdn": "A String", # Fully qualified domain name.
+                    "ipAddress": "A String", # Assigned or configured IP Address.
+                    "subnetMask": "A String", # Subnet mask.
+                  },
+                ],
+              },
+              "macAddress": "A String", # MAC address.
+            },
+          ],
           "networkAdapters": [ # Network adapter descriptions.
             { # Details of network adapter.
               "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -838,6 +983,15 @@ 
Method Details

                     "subnetMask": "A String", # Subnet mask.
                   },
                 ],
+                "entries": [ # Network address entries.
+                  { # Details of network address.
+                    "assignment": "A String", # Whether DHCP is used to assign addresses.
+                    "bcast": "A String", # Broadcast address.
+                    "fqdn": "A String", # Fully qualified domain name.
+                    "ipAddress": "A String", # Assigned or configured IP Address.
+                    "subnetMask": "A String", # Subnet mask.
+                  },
+                ],
               },
               "macAddress": "A String", # MAC address.
             },
@@ -1085,7 +1239,11 @@ 
Method Details

               "biosName": "A String", # BIOS name.
               "biosReleaseDate": "A String", # BIOS release date.
               "biosVersion": "A String", # BIOS version.
+              "id": "A String", # BIOS ID.
+              "manufacturer": "A String", # BIOS manufacturer.
+              "releaseTime": "A String", # BIOS release date.
               "smbiosUuid": "A String", # SMBIOS UUID.
+              "version": "A String", # BIOS version.
             },
             "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
             "cpuManufacturer": "A String", # Optional. CPU manufacturer, e.g., "Intel", "AMD".
@@ -1118,8 +1276,10 @@ 
Method Details

             "disks": { # VM disks. # List of disks.
               "entries": [ # Disk entries.
                 { # Single disk entry.
+                  "capacityBytes": "A String", # Disk capacity.
                   "diskLabel": "A String", # Disk label.
                   "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+                  "freeSpaceBytes": "A String", # Disk free space.
                   "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
                   "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
                   "partitions": { # Disk partition list. # Partition layout.
@@ -1184,12 +1344,17 @@ 
Method Details

                 "enabled": True or False, # Is SELinux enabled.
                 "mode": "A String", # SELinux mode enforcing / permissive.
               },
+              "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
             },
+            "family": "A String", # What family the OS belong to, if known.
+            "osName": "A String", # The name of the operating system.
             "runtime": { # Guest OS runtime information. # Runtime information.
               "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
               "installedApps": { # Guest installed application list. # Installed applications information.
                 "entries": [ # Application entries.
                   { # Guest installed application information.
+                    "applicationName": "A String", # Installed application name.
+                    "installTime": "A String", # The time when the application was installed.
                     "licenses": [ # License strings associated with the installed application.
                       "A String",
                     ],
@@ -1201,6 +1366,7 @@ 
Method Details

                   },
                 ],
               },
+              "lastBootTime": "A String", # Last time the OS was booted.
               "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
                 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -1237,6 +1403,8 @@ 
Method Details

                   "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                   "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                 },
+                "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+                "scanTime": "A String", # Time of the last network scan.
               },
               "openFileList": { # Open file list. # Open files information.
                 "entries": [ # Open file details entries.
@@ -1249,6 +1417,17 @@ 
Method Details

                 ],
               },
               "processes": { # List of running guest OS processes. # Running processes.
+                "entries": [ # Running process entries.
+                  { # Guest OS running process details.
+                    "attributes": { # Process extended attributes.
+                      "a_key": "A String",
+                    },
+                    "cmdline": "A String", # Process full command line.
+                    "exePath": "A String", # Process binary path.
+                    "pid": "A String", # Process ID.
+                    "user": "A String", # User running the process.
+                  },
+                ],
                 "processes": [ # Running process entries.
                   { # Guest OS running process details.
                     "attributes": { # Process extended attributes.
@@ -1262,12 +1441,25 @@ 
Method Details

                 ],
               },
               "services": { # List of running guest OS services. # Running background services.
+                "entries": [ # Running service entries.
+                  { # Guest OS running service details.
+                    "cmdline": "A String", # Service command line.
+                    "exePath": "A String", # Service binary path.
+                    "name": "A String", # Service name.
+                    "pid": "A String", # Service pid.
+                    "serviceName": "A String", # Service name.
+                    "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                    "state": "A String", # Service state (raw, OS-agnostic).
+                    "status": "A String", # Service status.
+                  },
+                ],
                 "services": [ # Running service entries.
                   { # Guest OS running service details.
                     "cmdline": "A String", # Service command line.
                     "exePath": "A String", # Service binary path.
                     "name": "A String", # Service name.
                     "pid": "A String", # Service pid.
+                    "serviceName": "A String", # Service name.
                     "startMode": "A String", # Service start mode (raw, OS-agnostic).
                     "state": "A String", # Service state (raw, OS-agnostic).
                     "status": "A String", # Service status.
@@ -1275,12 +1467,39 @@ 
Method Details

                 ],
               },
             },
+            "version": "A String", # The version of the operating system.
           },
           "machineName": "A String", # Machine name.
           "memoryMb": 42, # The amount of memory in the machine. Must be non-negative.
           "network": { # Details of network adapters and settings. # Network details.
             "defaultGateway": "A String", # Default gateway address.
             "networkAdapters": { # List of network adapters. # List of network adapters.
+              "entries": [ # Network adapter entries.
+                { # Details of network adapter.
+                  "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+                  "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                    "addresses": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
+                    "entries": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
+                  },
+                  "macAddress": "A String", # MAC address.
+                },
+              ],
               "networkAdapters": [ # Network adapter descriptions.
                 { # Details of network adapter.
                   "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -1294,6 +1513,15 @@ 
Method Details

                         "subnetMask": "A String", # Subnet mask.
                       },
                     ],
+                    "entries": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
                   },
                   "macAddress": "A String", # MAC address.
                 },
@@ -1327,7 +1555,10 @@ 
Method Details

               "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
               "esxVersion": "A String", # ESX version.
               "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+              "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+              "vcenterUri": "A String", # vCenter URI used in collection.
               "vcenterVersion": "A String", # vCenter version.
+              "vcenterVmId": "A String", # vCenter VM ID.
             },
           },
           "powerState": "A String", # Power state of the machine.
@@ -1417,12 +1648,17 @@ 
Method Details

                 "enabled": True or False, # Is SELinux enabled.
                 "mode": "A String", # SELinux mode enforcing / permissive.
               },
+              "selinuxMode": "A String", # Security-Enhanced Linux (SELinux) mode.
             },
+            "family": "A String", # What family the OS belong to, if known.
+            "osName": "A String", # The name of the operating system.
             "runtime": { # Guest OS runtime information. # Runtime information.
               "domain": "A String", # Domain, e.g. c.stratozone-development.internal.
               "installedApps": { # Guest installed application list. # Installed applications information.
                 "entries": [ # Application entries.
                   { # Guest installed application information.
+                    "applicationName": "A String", # Installed application name.
+                    "installTime": "A String", # The time when the application was installed.
                     "licenses": [ # License strings associated with the installed application.
                       "A String",
                     ],
@@ -1434,6 +1670,7 @@ 
Method Details

                   },
                 ],
               },
+              "lastBootTime": "A String", # Last time the OS was booted.
               "lastUptime": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date since last booted (last uptime date).
                 "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
                 "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -1470,6 +1707,8 @@ 
Method Details

                   "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
                   "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
                 },
+                "rawScanResult": "A String", # Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.
+                "scanTime": "A String", # Time of the last network scan.
               },
               "openFileList": { # Open file list. # Open files information.
                 "entries": [ # Open file details entries.
@@ -1482,6 +1721,17 @@ 
Method Details

                 ],
               },
               "processes": { # List of running guest OS processes. # Running processes.
+                "entries": [ # Running process entries.
+                  { # Guest OS running process details.
+                    "attributes": { # Process extended attributes.
+                      "a_key": "A String",
+                    },
+                    "cmdline": "A String", # Process full command line.
+                    "exePath": "A String", # Process binary path.
+                    "pid": "A String", # Process ID.
+                    "user": "A String", # User running the process.
+                  },
+                ],
                 "processes": [ # Running process entries.
                   { # Guest OS running process details.
                     "attributes": { # Process extended attributes.
@@ -1495,12 +1745,25 @@ 
Method Details

                 ],
               },
               "services": { # List of running guest OS services. # Running background services.
+                "entries": [ # Running service entries.
+                  { # Guest OS running service details.
+                    "cmdline": "A String", # Service command line.
+                    "exePath": "A String", # Service binary path.
+                    "name": "A String", # Service name.
+                    "pid": "A String", # Service pid.
+                    "serviceName": "A String", # Service name.
+                    "startMode": "A String", # Service start mode (raw, OS-agnostic).
+                    "state": "A String", # Service state (raw, OS-agnostic).
+                    "status": "A String", # Service status.
+                  },
+                ],
                 "services": [ # Running service entries.
                   { # Guest OS running service details.
                     "cmdline": "A String", # Service command line.
                     "exePath": "A String", # Service binary path.
                     "name": "A String", # Service name.
                     "pid": "A String", # Service pid.
+                    "serviceName": "A String", # Service name.
                     "startMode": "A String", # Service start mode (raw, OS-agnostic).
                     "state": "A String", # Service state (raw, OS-agnostic).
                     "status": "A String", # Service status.
@@ -1508,6 +1771,7 @@ 
Method Details

                 ],
               },
             },
+            "version": "A String", # The version of the operating system.
           },
           "memoryMb": 42, # The amount of memory in the VirtualMachine. Must be non-negative.
           "osFamily": "A String", # What family the OS belong to, if known.
@@ -1537,7 +1801,10 @@ 
Method Details

               "esxHyperthreading": "A String", # Whether the ESX is hyperthreaded.
               "esxVersion": "A String", # ESX version.
               "osid": "A String", # VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.
+              "vcenterFolder": "A String", # Folder name in vCenter where asset resides.
+              "vcenterUri": "A String", # vCenter URI used in collection.
               "vcenterVersion": "A String", # vCenter version.
+              "vcenterVmId": "A String", # vCenter VM ID.
             },
           },
           "powerState": "A String", # Power state of VM (poweredOn or poweredOff).
@@ -1550,7 +1817,11 @@ 
Method Details

               "biosName": "A String", # BIOS name.
               "biosReleaseDate": "A String", # BIOS release date.
               "biosVersion": "A String", # BIOS version.
+              "id": "A String", # BIOS ID.
+              "manufacturer": "A String", # BIOS manufacturer.
+              "releaseTime": "A String", # BIOS release date.
               "smbiosUuid": "A String", # SMBIOS UUID.
+              "version": "A String", # BIOS version.
             },
             "cpuArchitecture": "A String", # CPU architecture, e.g., "x64-based PC", "x86_64", "i686" etc.
             "cpuManufacturer": "A String", # CPU manufacturer, e.g., "Intel", "AMD".
@@ -1565,8 +1836,10 @@ 
Method Details

             "disks": { # VM disks. # List of disks.
               "entries": [ # Disk entries.
                 { # Single disk entry.
+                  "capacityBytes": "A String", # Disk capacity.
                   "diskLabel": "A String", # Disk label.
                   "diskLabelType": "A String", # Disk label type (e.g. BIOS/GPT)
+                  "freeSpaceBytes": "A String", # Disk free space.
                   "hwAddress": "A String", # Disk hardware address (e.g. 0:1 for SCSI).
                   "interfaceType": "A String", # Disks interface type (e.g. SATA/SCSI)
                   "partitions": { # Disk partition list. # Partition layout.
@@ -1596,6 +1869,32 @@ 
Method Details

           "vmNetwork": { # Details of network adapters and settings. # VM network details.
             "defaultGw": "A String", # Default gateway address.
             "networkAdapters": { # List of network adapters. # List of network adapters.
+              "entries": [ # Network adapter entries.
+                { # Details of network adapter.
+                  "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
+                  "addresses": { # List of allocated/assigned network addresses. # NetworkAddressList
+                    "addresses": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
+                    "entries": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
+                  },
+                  "macAddress": "A String", # MAC address.
+                },
+              ],
               "networkAdapters": [ # Network adapter descriptions.
                 { # Details of network adapter.
                   "adapterType": "A String", # Network adapter type (e.g. VMXNET3).
@@ -1609,6 +1908,15 @@ 
Method Details

                         "subnetMask": "A String", # Subnet mask.
                       },
                     ],
+                    "entries": [ # Network address entries.
+                      { # Details of network address.
+                        "assignment": "A String", # Whether DHCP is used to assign addresses.
+                        "bcast": "A String", # Broadcast address.
+                        "fqdn": "A String", # Fully qualified domain name.
+                        "ipAddress": "A String", # Assigned or configured IP Address.
+                        "subnetMask": "A String", # Subnet mask.
+                      },
+                    ],
                   },
                   "macAddress": "A String", # MAC address.
                 },
diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json
index cf1354693bd..0ebe62fd5f4 100644
--- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json
@@ -2554,7 +2554,7 @@
 }
 }
 },
-"revision": "20250910",
+"revision": "20250917",
 "rootUrl": "https://migrationcenter.googleapis.com/",
 "schemas": {
 "AddAssetsToGroupRequest": {
@@ -3527,9 +3527,26 @@
 "description": "BIOS version.",
 "type": "string"
 },
+"id": {
+"description": "BIOS ID.",
+"type": "string"
+},
+"manufacturer": {
+"description": "BIOS manufacturer.",
+"type": "string"
+},
+"releaseTime": {
+"description": "BIOS release date.",
+"format": "google-datetime",
+"type": "string"
+},
 "smbiosUuid": {
 "description": "SMBIOS UUID.",
 "type": "string"
+},
+"version": {
+"description": "BIOS version.",
+"type": "string"
 }
 },
 "type": "object"
@@ -4860,6 +4877,11 @@
 "description": "Single disk entry.",
 "id": "DiskEntry",
 "properties": {
+"capacityBytes": {
+"description": "Disk capacity.",
+"format": "int64",
+"type": "string"
+},
 "diskLabel": {
 "description": "Disk label.",
 "type": "string"
@@ -4868,6 +4890,11 @@
 "description": "Disk label type (e.g. BIOS/GPT)",
 "type": "string"
 },
+"freeSpaceBytes": {
+"description": "Disk free space.",
+"format": "int64",
+"type": "string"
+},
 "hwAddress": {
 "description": "Disk hardware address (e.g. 0:1 for SCSI).",
 "type": "string"
@@ -5367,6 +5394,22 @@ false
 "selinux": {
 "$ref": "Selinux",
 "description": "SELinux details."
+},
+"selinuxMode": {
+"description": "Security-Enhanced Linux (SELinux) mode.",
+"enum": [
+"SE_LINUX_MODE_UNSPECIFIED",
+"SE_LINUX_MODE_DISABLED",
+"SE_LINUX_MODE_PERMISSIVE",
+"SE_LINUX_MODE_ENFORCING"
+],
+"enumDescriptions": [
+"SELinux mode unknown or unspecified.",
+"SELinux is disabled.",
+"SELinux permissive mode.",
+"SELinux enforcing mode."
+],
+"type": "string"
 }
 },
 "type": "object"
@@ -5375,6 +5418,15 @@ false
 "description": "Guest installed application information.",
 "id": "GuestInstalledApplication",
 "properties": {
+"applicationName": {
+"description": "Installed application name.",
+"type": "string"
+},
+"installTime": {
+"description": "The time when the application was installed.",
+"format": "google-datetime",
+"type": "string"
+},
 "licenses": {
 "description": "License strings associated with the installed application.",
 "items": {
@@ -5427,9 +5479,33 @@ false
 "$ref": "GuestConfigDetails",
 "description": "OS and app configuration."
 },
+"family": {
+"description": "What family the OS belong to, if known.",
+"enum": [
+"OS_FAMILY_UNKNOWN",
+"OS_FAMILY_WINDOWS",
+"OS_FAMILY_LINUX",
+"OS_FAMILY_UNIX"
+],
+"enumDescriptions": [
+"",
+"Microsoft Windows Server and Desktop.",
+"Various Linux flavors.",
+"Non-Linux Unix flavors."
+],
+"type": "string"
+},
+"osName": {
+"description": "The name of the operating system.",
+"type": "string"
+},
 "runtime": {
 "$ref": "GuestRuntimeDetails",
 "description": "Runtime information."
+},
+"version": {
+"description": "The version of the operating system.",
+"type": "string"
 }
 },
 "type": "object"
@@ -5446,6 +5522,11 @@ false
 "$ref": "GuestInstalledApplicationList",
 "description": "Installed applications information."
 },
+"lastBootTime": {
+"description": "Last time the OS was booted.",
+"format": "google-datetime",
+"type": "string"
+},
 "lastUptime": {
 "$ref": "Date",
 "description": "Date since last booted (last uptime date)."
@@ -6811,6 +6892,13 @@ false
 "description": "List of network adapters.",
 "id": "NetworkAdapterList",
 "properties": {
+"entries": {
+"description": "Network adapter entries.",
+"items": {
+"$ref": "NetworkAdapterDetails"
+},
+"type": "array"
+},
 "networkAdapters": {
 "description": "Network adapter descriptions.",
 "items": {
@@ -6868,6 +6956,13 @@ false
 "$ref": "NetworkAddress"
 },
 "type": "array"
+},
+"entries": {
+"description": "Network address entries.",
+"items": {
+"$ref": "NetworkAddress"
+},
+"type": "array"
 }
 },
 "type": "object"
@@ -8011,7 +8106,8 @@ false
 "type": "string"
 },
 "allocatedDiskTypes": {
-"description": "Set of disk types allocated to assets.",
+"deprecated": true,
+"description": "@deprecated. Use storage_allocations instead. Set of disk types allocated to assets.",
 "items": {
 "enum": [
 "PERSISTENT_DISK_TYPE_UNSPECIFIED",
@@ -8264,6 +8360,13 @@ false
 "description": "List of running guest OS processes.",
 "id": "RunningProcessList",
 "properties": {
+"entries": {
+"description": "Running process entries.",
+"items": {
+"$ref": "RunningProcess"
+},
+"type": "array"
+},
 "processes": {
 "description": "Running process entries.",
 "items": {
@@ -8295,6 +8398,10 @@ false
 "format": "int64",
 "type": "string"
 },
+"serviceName": {
+"description": "Service name.",
+"type": "string"
+},
 "startMode": {
 "description": "Service start mode (raw, OS-agnostic).",
 "type": "string"
@@ -8314,6 +8421,13 @@ false
 "description": "List of running guest OS services.",
 "id": "RunningServiceList",
 "properties": {
+"entries": {
+"description": "Running service entries.",
+"items": {
+"$ref": "RunningService"
+},
+"type": "array"
+},
 "services": {
 "description": "Running service entries.",
 "items": {
@@ -8339,6 +8453,15 @@ false
 "netstatTime": {
 "$ref": "DateTime",
 "description": "Netstat time collected."
+},
+"rawScanResult": {
+"description": "Raw network scan result. This field is intended for human inspection. The format of this field may be netstat output or any another raw output. The exact format may change without notice and should not be relied upon.",
+"type": "string"
+},
+"scanTime": {
+"description": "Time of the last network scan.",
+"format": "google-datetime",
+"type": "string"
 }
 },
 "type": "object"
@@ -9328,9 +9451,21 @@ false
 "description": "VMware os enum - https://vdc-repo.vmware.com/vmwb-repository/dcr-public/da47f910-60ac-438b-8b9b-6122f4d14524/16b7274a-bf8b-4b4c-a05e-746f2aa93c8c/doc/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html.",
 "type": "string"
 },
+"vcenterFolder": {
+"description": "Folder name in vCenter where asset resides.",
+"type": "string"
+},
+"vcenterUri": {
+"description": "vCenter URI used in collection.",
+"type": "string"
+},
 "vcenterVersion": {
 "description": "vCenter version.",
 "type": "string"
+},
+"vcenterVmId": {
+"description": "vCenter VM ID.",
+"type": "string"
 }
 },
 "type": "object"

From a40b629454024d4bcfa156c3c5c19176eb09026c Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:08 +0000
Subject: [PATCH 19/26] feat(netapp): update the api

#### netapp:v1

The following keys were added:
- endpoints (Total Keys: 1)
- resources.projects.resources.locations.resources.volumes.methods.restore (Total Keys: 12)
- schemas.CacheConfig (Total Keys: 3)
- schemas.CacheParameters (Total Keys: 19)
- schemas.RestoreBackupFilesRequest (Total Keys: 6)
- schemas.Volume.properties.cacheParameters.$ref (Total Keys: 1)

#### netapp:v1beta1

The following keys were added:
- endpoints (Total Keys: 1)
---
 .../netapp_v1.projects.locations.volumes.html | 117 ++++++
 ...pp_v1beta1.projects.locations.volumes.html |   2 +-
 .../discovery_cache/documents/netapp.v1.json  | 352 +++++++++++++++++-
 .../documents/netapp.v1beta1.json             | 216 ++++++++++-
 4 files changed, 683 insertions(+), 4 deletions(-)

diff --git a/docs/dyn/netapp_v1.projects.locations.volumes.html b/docs/dyn/netapp_v1.projects.locations.volumes.html
index 7f9691703be..e624240f27b 100644
--- a/docs/dyn/netapp_v1.projects.locations.volumes.html
+++ b/docs/dyn/netapp_v1.projects.locations.volumes.html
@@ -110,6 +110,9 @@ 
Instance Methods

 

   patch(name, body=None, updateMask=None, x__xgafv=None)

 
Updates the parameters of a single Volume.

+

+  restore(name, body=None, x__xgafv=None)

+
Restore files from a backup to a volume.

 

   revert(name, body=None, x__xgafv=None)

 
Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.

@@ -138,6 +141,23 @@ 
Method Details

     "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
     "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
   },
+  "cacheParameters": { # Cache Parameters for the volume. # Optional. Cache parameters for the volume.
+    "cacheConfig": { # Configuration of the cache volume. # Optional. Configuration of the cache volume.
+      "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume.
+    },
+    "cacheState": "A String", # Output only. State of the cache volume indicating the peering status.
+    "command": "A String", # Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.
+    "enableGlobalFileLock": True or False, # Optional. Field indicating whether cache volume as global file lock enabled.
+    "passphrase": "A String", # Output only. Temporary passphrase generated to accept cluster peering command.
+    "peerClusterName": "A String", # Required. Name of the origin volume's ONTAP cluster.
+    "peerIpAddresses": [ # Required. List of IC LIF addresses of the origin volume's ONTAP cluster.
+      "A String",
+    ],
+    "peerSvmName": "A String", # Required. Name of the origin volume's SVM.
+    "peerVolumeName": "A String", # Required. Name of the origin volume for the cache volume.
+    "peeringCommandExpiryTime": "A String", # Optional. Expiration time for the peering command to be executed on user's ONTAP.
+    "stateDetails": "A String", # Output only. Detailed description of the current cache state.
+  },
   "capacityGib": "A String", # Required. Capacity in GIB of the volume
   "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB.
   "createTime": "A String", # Output only. Create time of the volume
@@ -348,6 +368,23 @@ 
Method Details

     "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
     "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
   },
+  "cacheParameters": { # Cache Parameters for the volume. # Optional. Cache parameters for the volume.
+    "cacheConfig": { # Configuration of the cache volume. # Optional. Configuration of the cache volume.
+      "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume.
+    },
+    "cacheState": "A String", # Output only. State of the cache volume indicating the peering status.
+    "command": "A String", # Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.
+    "enableGlobalFileLock": True or False, # Optional. Field indicating whether cache volume as global file lock enabled.
+    "passphrase": "A String", # Output only. Temporary passphrase generated to accept cluster peering command.
+    "peerClusterName": "A String", # Required. Name of the origin volume's ONTAP cluster.
+    "peerIpAddresses": [ # Required. List of IC LIF addresses of the origin volume's ONTAP cluster.
+      "A String",
+    ],
+    "peerSvmName": "A String", # Required. Name of the origin volume's SVM.
+    "peerVolumeName": "A String", # Required. Name of the origin volume for the cache volume.
+    "peeringCommandExpiryTime": "A String", # Optional. Expiration time for the peering command to be executed on user's ONTAP.
+    "stateDetails": "A String", # Output only. Detailed description of the current cache state.
+  },
   "capacityGib": "A String", # Required. Capacity in GIB of the volume
   "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB.
   "createTime": "A String", # Output only. Create time of the volume
@@ -503,6 +540,23 @@ 
Method Details

         "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
         "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
       },
+      "cacheParameters": { # Cache Parameters for the volume. # Optional. Cache parameters for the volume.
+        "cacheConfig": { # Configuration of the cache volume. # Optional. Configuration of the cache volume.
+          "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume.
+        },
+        "cacheState": "A String", # Output only. State of the cache volume indicating the peering status.
+        "command": "A String", # Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.
+        "enableGlobalFileLock": True or False, # Optional. Field indicating whether cache volume as global file lock enabled.
+        "passphrase": "A String", # Output only. Temporary passphrase generated to accept cluster peering command.
+        "peerClusterName": "A String", # Required. Name of the origin volume's ONTAP cluster.
+        "peerIpAddresses": [ # Required. List of IC LIF addresses of the origin volume's ONTAP cluster.
+          "A String",
+        ],
+        "peerSvmName": "A String", # Required. Name of the origin volume's SVM.
+        "peerVolumeName": "A String", # Required. Name of the origin volume for the cache volume.
+        "peeringCommandExpiryTime": "A String", # Optional. Expiration time for the peering command to be executed on user's ONTAP.
+        "stateDetails": "A String", # Output only. Detailed description of the current cache state.
+      },
       "capacityGib": "A String", # Required. Capacity in GIB of the volume
       "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB.
       "createTime": "A String", # Output only. Create time of the volume
@@ -659,6 +713,23 @@ 
Method Details

     "backupVault": "A String", # Optional. Name of backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}
     "scheduledBackupEnabled": True or False, # Optional. When set to true, scheduled backup is enabled on the volume. This field should be nil when there's no backup policy attached.
   },
+  "cacheParameters": { # Cache Parameters for the volume. # Optional. Cache parameters for the volume.
+    "cacheConfig": { # Configuration of the cache volume. # Optional. Configuration of the cache volume.
+      "cifsChangeNotifyEnabled": True or False, # Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume.
+    },
+    "cacheState": "A String", # Output only. State of the cache volume indicating the peering status.
+    "command": "A String", # Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.
+    "enableGlobalFileLock": True or False, # Optional. Field indicating whether cache volume as global file lock enabled.
+    "passphrase": "A String", # Output only. Temporary passphrase generated to accept cluster peering command.
+    "peerClusterName": "A String", # Required. Name of the origin volume's ONTAP cluster.
+    "peerIpAddresses": [ # Required. List of IC LIF addresses of the origin volume's ONTAP cluster.
+      "A String",
+    ],
+    "peerSvmName": "A String", # Required. Name of the origin volume's SVM.
+    "peerVolumeName": "A String", # Required. Name of the origin volume for the cache volume.
+    "peeringCommandExpiryTime": "A String", # Optional. Expiration time for the peering command to be executed on user's ONTAP.
+    "stateDetails": "A String", # Output only. Detailed description of the current cache state.
+  },
   "capacityGib": "A String", # Required. Capacity in GIB of the volume
   "coldTierSizeGib": "A String", # Output only. Size of the volume cold tier data rounded down to the nearest GiB.
   "createTime": "A String", # Output only. Create time of the volume
@@ -809,6 +880,52 @@ 
Method Details

 }

 

 
+

+    restore(name, body=None, x__xgafv=None)
+  
Restore files from a backup to a volume.
+
+Args:
+  name: string, Required. The volume resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RestoreBackupFilesRequest restores files from a backup to a volume.
+  "backup": "A String", # Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`
+  "fileList": [ # Required. List of files to be restored in the form of their absolute path as in source volume.
+    "A String",
+  ],
+  "restoreDestinationPath": "A String", # Optional. Absolute directory path in the destination volume.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
 

     revert(name, body=None, x__xgafv=None)
   
Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.
diff --git a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html
index be144421f64..5b98e1d6fc0 100644
--- a/docs/dyn/netapp_v1beta1.projects.locations.volumes.html
+++ b/docs/dyn/netapp_v1beta1.projects.locations.volumes.html
@@ -944,7 +944,7 @@ 
Method Details

   "fileList": [ # Required. List of files to be restored in the form of their absolute path as in source volume.
     "A String",
   ],
-  "restoreDestinationPath": "A String", # Required. Absolute directory path in the destination volume.
+  "restoreDestinationPath": "A String", # Optional. Absolute directory path in the destination volume.
 }
 
   x__xgafv: string, V1 error format.
diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json
index 3d1b6acc95c..f43a6dba89e 100644
--- a/googleapiclient/discovery_cache/documents/netapp.v1.json
+++ b/googleapiclient/discovery_cache/documents/netapp.v1.json
@@ -15,6 +15,218 @@
 "description": "Google Cloud NetApp Volumes is a fully-managed, cloud-based data storage service that provides advanced data management capabilities and highly scalable performance with global availability.",
 "discoveryVersion": "v1",
 "documentationLink": "https://cloud.google.com/netapp/",
+"endpoints": [
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.africa-south1.rep.googleapis.com/",
+"location": "africa-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-east1.rep.googleapis.com/",
+"location": "asia-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-east2.rep.googleapis.com/",
+"location": "asia-east2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-northeast1.rep.googleapis.com/",
+"location": "asia-northeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-northeast2.rep.googleapis.com/",
+"location": "asia-northeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-northeast3.rep.googleapis.com/",
+"location": "asia-northeast3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-south1.rep.googleapis.com/",
+"location": "asia-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-south2.rep.googleapis.com/",
+"location": "asia-south2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-southeast1.rep.googleapis.com/",
+"location": "asia-southeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-southeast2.rep.googleapis.com/",
+"location": "asia-southeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.australia-southeast1.rep.googleapis.com/",
+"location": "australia-southeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.australia-southeast2.rep.googleapis.com/",
+"location": "australia-southeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-central2.rep.googleapis.com/",
+"location": "europe-central2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-north1.rep.googleapis.com/",
+"location": "europe-north1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-southwest1.rep.googleapis.com/",
+"location": "europe-southwest1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west1.rep.googleapis.com/",
+"location": "europe-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west10.rep.googleapis.com/",
+"location": "europe-west10"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west12.rep.googleapis.com/",
+"location": "europe-west12"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west2.rep.googleapis.com/",
+"location": "europe-west2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west3.rep.googleapis.com/",
+"location": "europe-west3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west4.rep.googleapis.com/",
+"location": "europe-west4"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west6.rep.googleapis.com/",
+"location": "europe-west6"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west8.rep.googleapis.com/",
+"location": "europe-west8"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west9.rep.googleapis.com/",
+"location": "europe-west9"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.me-central1.rep.googleapis.com/",
+"location": "me-central1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.me-central2.rep.googleapis.com/",
+"location": "me-central2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.me-west1.rep.googleapis.com/",
+"location": "me-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.northamerica-northeast1.rep.googleapis.com/",
+"location": "northamerica-northeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.northamerica-northeast2.rep.googleapis.com/",
+"location": "northamerica-northeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.northamerica-south1.rep.googleapis.com/",
+"location": "northamerica-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.southamerica-east1.rep.googleapis.com/",
+"location": "southamerica-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.southamerica-west1.rep.googleapis.com/",
+"location": "southamerica-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-central1.rep.googleapis.com/",
+"location": "us-central1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-east1.rep.googleapis.com/",
+"location": "us-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-east4.rep.googleapis.com/",
+"location": "us-east4"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-east5.rep.googleapis.com/",
+"location": "us-east5"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-east7.rep.googleapis.com/",
+"location": "us-east7"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-south1.rep.googleapis.com/",
+"location": "us-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-west1.rep.googleapis.com/",
+"location": "us-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-west2.rep.googleapis.com/",
+"location": "us-west2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-west3.rep.googleapis.com/",
+"location": "us-west3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-west4.rep.googleapis.com/",
+"location": "us-west4"
+}
+],
 "fullyEncodeReservedExpansion": true,
 "icons": {
 "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -1592,6 +1804,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"restore": {
+"description": "Restore files from a backup to a volume.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:restore",
+"httpMethod": "POST",
+"id": "netapp.projects.locations.volumes.restore",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The volume resource name, in the format `projects/{project_id}/locations/{location}/volumes/{volume_id}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/volumes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:restore",
+"request": {
+"$ref": "RestoreBackupFilesRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "revert": {
 "description": "Revert an existing volume to a specified snapshot. Warning! This operation will permanently revert all changes made after the snapshot was created.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumes/{volumesId}:revert",
@@ -2270,7 +2510,7 @@
 }
 }
 },
-"revision": "20250908",
+"revision": "20250917",
 "rootUrl": "https://netapp.googleapis.com/",
 "schemas": {
 "ActiveDirectory": {
@@ -2732,6 +2972,90 @@
 },
 "type": "object"
 },
+"CacheConfig": {
+"description": "Configuration of the cache volume.",
+"id": "CacheConfig",
+"properties": {
+"cifsChangeNotifyEnabled": {
+"description": "Optional. Flag indicating whether a CIFS change notification is enabled for the FlexCache volume.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"CacheParameters": {
+"description": "Cache Parameters for the volume.",
+"id": "CacheParameters",
+"properties": {
+"cacheConfig": {
+"$ref": "CacheConfig",
+"description": "Optional. Configuration of the cache volume."
+},
+"cacheState": {
+"description": "Output only. State of the cache volume indicating the peering status.",
+"enum": [
+"CACHE_STATE_UNSPECIFIED",
+"PENDING_CLUSTER_PEERING",
+"PENDING_SVM_PEERING",
+"PEERED",
+"ERROR"
+],
+"enumDescriptions": [
+"Default unspecified state.",
+"State indicating waiting for cluster peering to be established.",
+"State indicating waiting for SVM peering to be established.",
+"State indicating successful establishment of peering with origin volumes's ONTAP cluster.",
+"Terminal state wherein peering with origin volume's ONTAP cluster has failed."
+],
+"readOnly": true,
+"type": "string"
+},
+"command": {
+"description": "Output only. Copy-paste-able commands to be used on user's ONTAP to accept peering requests.",
+"readOnly": true,
+"type": "string"
+},
+"enableGlobalFileLock": {
+"description": "Optional. Field indicating whether cache volume as global file lock enabled.",
+"type": "boolean"
+},
+"passphrase": {
+"description": "Output only. Temporary passphrase generated to accept cluster peering command.",
+"readOnly": true,
+"type": "string"
+},
+"peerClusterName": {
+"description": "Required. Name of the origin volume's ONTAP cluster.",
+"type": "string"
+},
+"peerIpAddresses": {
+"description": "Required. List of IC LIF addresses of the origin volume's ONTAP cluster.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"peerSvmName": {
+"description": "Required. Name of the origin volume's SVM.",
+"type": "string"
+},
+"peerVolumeName": {
+"description": "Required. Name of the origin volume for the cache volume.",
+"type": "string"
+},
+"peeringCommandExpiryTime": {
+"description": "Optional. Expiration time for the peering command to be executed on user's ONTAP.",
+"format": "google-datetime",
+"type": "string"
+},
+"stateDetails": {
+"description": "Output only. Detailed description of the current cache state.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "CancelOperationRequest": {
 "description": "The request message for Operations.CancelOperation.",
 "id": "CancelOperationRequest",
@@ -3838,6 +4162,28 @@
 },
 "type": "object"
 },
+"RestoreBackupFilesRequest": {
+"description": "RestoreBackupFilesRequest restores files from a backup to a volume.",
+"id": "RestoreBackupFilesRequest",
+"properties": {
+"backup": {
+"description": "Required. The backup resource name, in the format `projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}/backups/{backup_id}`",
+"type": "string"
+},
+"fileList": {
+"description": "Required. List of files to be restored in the form of their absolute path as in source volume.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"restoreDestinationPath": {
+"description": "Optional. Absolute directory path in the destination volume.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "RestoreParameters": {
 "description": "The RestoreParameters if volume is created from a snapshot or backup.",
 "id": "RestoreParameters",
@@ -4460,6 +4806,10 @@
 "$ref": "BackupConfig",
 "description": "BackupConfig of the volume."
 },
+"cacheParameters": {
+"$ref": "CacheParameters",
+"description": "Optional. Cache parameters for the volume."
+},
 "capacityGib": {
 "description": "Required. Capacity in GIB of the volume",
 "format": "int64",
diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json
index c080ec51597..0083ec52b05 100644
--- a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json
@@ -15,6 +15,218 @@
 "description": "Google Cloud NetApp Volumes is a fully-managed, cloud-based data storage service that provides advanced data management capabilities and highly scalable performance with global availability.",
 "discoveryVersion": "v1",
 "documentationLink": "https://cloud.google.com/netapp/",
+"endpoints": [
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.africa-south1.rep.googleapis.com/",
+"location": "africa-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-east1.rep.googleapis.com/",
+"location": "asia-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-east2.rep.googleapis.com/",
+"location": "asia-east2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-northeast1.rep.googleapis.com/",
+"location": "asia-northeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-northeast2.rep.googleapis.com/",
+"location": "asia-northeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-northeast3.rep.googleapis.com/",
+"location": "asia-northeast3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-south1.rep.googleapis.com/",
+"location": "asia-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-south2.rep.googleapis.com/",
+"location": "asia-south2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-southeast1.rep.googleapis.com/",
+"location": "asia-southeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.asia-southeast2.rep.googleapis.com/",
+"location": "asia-southeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.australia-southeast1.rep.googleapis.com/",
+"location": "australia-southeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.australia-southeast2.rep.googleapis.com/",
+"location": "australia-southeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-central2.rep.googleapis.com/",
+"location": "europe-central2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-north1.rep.googleapis.com/",
+"location": "europe-north1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-southwest1.rep.googleapis.com/",
+"location": "europe-southwest1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west1.rep.googleapis.com/",
+"location": "europe-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west10.rep.googleapis.com/",
+"location": "europe-west10"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west12.rep.googleapis.com/",
+"location": "europe-west12"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west2.rep.googleapis.com/",
+"location": "europe-west2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west3.rep.googleapis.com/",
+"location": "europe-west3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west4.rep.googleapis.com/",
+"location": "europe-west4"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west6.rep.googleapis.com/",
+"location": "europe-west6"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west8.rep.googleapis.com/",
+"location": "europe-west8"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.europe-west9.rep.googleapis.com/",
+"location": "europe-west9"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.me-central1.rep.googleapis.com/",
+"location": "me-central1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.me-central2.rep.googleapis.com/",
+"location": "me-central2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.me-west1.rep.googleapis.com/",
+"location": "me-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.northamerica-northeast1.rep.googleapis.com/",
+"location": "northamerica-northeast1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.northamerica-northeast2.rep.googleapis.com/",
+"location": "northamerica-northeast2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.northamerica-south1.rep.googleapis.com/",
+"location": "northamerica-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.southamerica-east1.rep.googleapis.com/",
+"location": "southamerica-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.southamerica-west1.rep.googleapis.com/",
+"location": "southamerica-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-central1.rep.googleapis.com/",
+"location": "us-central1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-east1.rep.googleapis.com/",
+"location": "us-east1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-east4.rep.googleapis.com/",
+"location": "us-east4"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-east5.rep.googleapis.com/",
+"location": "us-east5"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-east7.rep.googleapis.com/",
+"location": "us-east7"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-south1.rep.googleapis.com/",
+"location": "us-south1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-west1.rep.googleapis.com/",
+"location": "us-west1"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-west2.rep.googleapis.com/",
+"location": "us-west2"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-west3.rep.googleapis.com/",
+"location": "us-west3"
+},
+{
+"description": "Regional Endpoint",
+"endpointUrl": "https://netapp.us-west4.rep.googleapis.com/",
+"location": "us-west4"
+}
+],
 "fullyEncodeReservedExpansion": true,
 "icons": {
 "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -2326,7 +2538,7 @@
 }
 }
 },
-"revision": "20250908",
+"revision": "20250917",
 "rootUrl": "https://netapp.googleapis.com/",
 "schemas": {
 "ActiveDirectory": {
@@ -4020,7 +4232,7 @@
 "type": "array"
 },
 "restoreDestinationPath": {
-"description": "Required. Absolute directory path in the destination volume.",
+"description": "Optional. Absolute directory path in the destination volume.",
 "type": "string"
 }
 },

From c5b7beda6b1ce2435fe4b00bf775d6d4cd3f7345 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:09 +0000
Subject: [PATCH 20/26] feat(networkconnectivity): update the api

#### networkconnectivity:v1

The following keys were added:
- schemas.RemoteTransportProfile.properties.flow (Total Keys: 2)
- schemas.RemoteTransportProfile.properties.labels.readOnly (Total Keys: 1)
- schemas.RemoteTransportProfile.properties.orderState (Total Keys: 2)
- schemas.RemoteTransportProfile.properties.provider (Total Keys: 4)
- schemas.RemoteTransportProfile.properties.region (Total Keys: 2)
- schemas.RemoteTransportProfile.properties.sla (Total Keys: 2)
- schemas.RemoteTransportProfile.properties.supportedBandwidths (Total Keys: 3)
- schemas.Transport.properties.adminEnabled.type (Total Keys: 1)
- schemas.Transport.properties.advertisedRoutes.type (Total Keys: 1)
- schemas.Transport.properties.bandwidth.type (Total Keys: 1)
- schemas.Transport.properties.generatedActivationKey (Total Keys: 2)
- schemas.Transport.properties.mtuLimit (Total Keys: 3)
- schemas.Transport.properties.network.type (Total Keys: 1)
- schemas.Transport.properties.providedActivationKey.type (Total Keys: 1)
- schemas.Transport.properties.region.type (Total Keys: 1)
- schemas.Transport.properties.remoteProfile.type (Total Keys: 1)
- schemas.Transport.properties.stackType.type (Total Keys: 1)
- schemas.Transport.properties.state (Total Keys: 2)
---
 ...orkconnectivity_v1.projects.locations.html |   2 +-
 ...cts.locations.remoteTransportProfiles.html |  50 ++--
 ...vity_v1.projects.locations.transports.html | 104 +++++--
 ...nectivity_v1alpha1.projects.locations.html |   2 +-
 .../documents/networkconnectivity.v1.json     | 254 ++++++++++++++++--
 .../networkconnectivity.v1alpha1.json         |   4 +-
 6 files changed, 344 insertions(+), 72 deletions(-)

diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.html b/docs/dyn/networkconnectivity_v1.projects.locations.html
index 8e485489a87..7f18e012bf1 100644
--- a/docs/dyn/networkconnectivity_v1.projects.locations.html
+++ b/docs/dyn/networkconnectivity_v1.projects.locations.html
@@ -190,7 +190,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.remoteTransportProfiles.html b/docs/dyn/networkconnectivity_v1.projects.locations.remoteTransportProfiles.html
index 8036cbc3238..1981ce60651 100644
--- a/docs/dyn/networkconnectivity_v1.projects.locations.remoteTransportProfiles.html
+++ b/docs/dyn/networkconnectivity_v1.projects.locations.remoteTransportProfiles.html
@@ -97,7 +97,7 @@ 
Method Details

   
Gets details of a single RemoteTransportProfile.
 
 Args:
-  name: string, Required. Name of the resource (required)
+  name: string, Required. Name of the resource. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -106,13 +106,23 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # Message describing RemoteTransportProfile object
-  "createTime": "A String", # Output only. [Output only] Create time stamp
-  "labels": { # Optional. Labels as key value pairs
+    { # Message describing RemoteTransportProfile object.
+  "createTime": "A String", # Output only. [Output only] Create time stamp.
+  "description": "A String", # Output only. Description of the profile.
+  "flow": "A String", # Output only. [Output only] Type of provisioning flows supported by this profile.
+  "labels": { # Output only. Labels as key value pairs.
     "a_key": "A String",
   },
-  "name": "A String", # Identifier. name of resource
-  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "name": "A String", # Identifier. Name of the resource in the format of $provider-$site.
+  "orderState": "A String", # Output only. [Output only] Order state for this profile.
+  "provider": "A String", # Output only. Name of the provider on the other end of this profile. E.g. “Amazon Web Services” or “Microsoft Azure”.
+  "providerSite": "A String", # Output only. If the profile is a Cloud Service Provider with compute resources, this is populated with the region where connectivity is being established. If the profile provides facility-level selection, this is an identity of the facility any connections on this profile are going through.
+  "region": "A String", # Output only. GCP Region where this profile is available.
+  "sla": "A String", # Output only. [Output only] Availability class that will be configured for this particular RemoteTransportProfile.
+  "supportedBandwidths": [ # Output only. List of bandwidth enum values that are supported by this profile.
+    "A String",
+  ],
+  "updateTime": "A String", # Output only. [Output only] Update time stamp.
 }

 

 
@@ -121,9 +131,9 @@ 
Method Details

   
Lists RemoteTransportProfiles in a given project and location.
 
 Args:
-  parent: string, Required. Parent value for ListRemoteTransportProfilesRequest (required)
-  filter: string, Optional. Filtering results
-  orderBy: string, Optional. Hint for how to order the results
+  parent: string, Required. Parent value for ListRemoteTransportProfilesRequest. (required)
+  filter: string, Optional. Filtering results.
+  orderBy: string, Optional. Hint for how to order the results.
   pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
   pageToken: string, Optional. A token identifying a page of results the server should return.
   x__xgafv: string, V1 error format.
@@ -136,14 +146,24 @@ 
Method Details

 
     { # Message for response to listing RemoteTransportProfiles
   "nextPageToken": "A String", # A token identifying a page of results the server should return.
-  "remoteTransportProfiles": [ # The list of RemoteTransportProfiles
-    { # Message describing RemoteTransportProfile object
-      "createTime": "A String", # Output only. [Output only] Create time stamp
-      "labels": { # Optional. Labels as key value pairs
+  "remoteTransportProfiles": [ # The list of RemoteTransportProfiles.
+    { # Message describing RemoteTransportProfile object.
+      "createTime": "A String", # Output only. [Output only] Create time stamp.
+      "description": "A String", # Output only. Description of the profile.
+      "flow": "A String", # Output only. [Output only] Type of provisioning flows supported by this profile.
+      "labels": { # Output only. Labels as key value pairs.
         "a_key": "A String",
       },
-      "name": "A String", # Identifier. name of resource
-      "updateTime": "A String", # Output only. [Output only] Update time stamp
+      "name": "A String", # Identifier. Name of the resource in the format of $provider-$site.
+      "orderState": "A String", # Output only. [Output only] Order state for this profile.
+      "provider": "A String", # Output only. Name of the provider on the other end of this profile. E.g. “Amazon Web Services” or “Microsoft Azure”.
+      "providerSite": "A String", # Output only. If the profile is a Cloud Service Provider with compute resources, this is populated with the region where connectivity is being established. If the profile provides facility-level selection, this is an identity of the facility any connections on this profile are going through.
+      "region": "A String", # Output only. GCP Region where this profile is available.
+      "sla": "A String", # Output only. [Output only] Availability class that will be configured for this particular RemoteTransportProfile.
+      "supportedBandwidths": [ # Output only. List of bandwidth enum values that are supported by this profile.
+        "A String",
+      ],
+      "updateTime": "A String", # Output only. [Output only] Update time stamp.
     },
   ],
   "unreachable": [ # Unordered list. Locations that could not be reached.
diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.transports.html b/docs/dyn/networkconnectivity_v1.projects.locations.transports.html
index 79c70f46f07..28787174eff 100644
--- a/docs/dyn/networkconnectivity_v1.projects.locations.transports.html
+++ b/docs/dyn/networkconnectivity_v1.projects.locations.transports.html
@@ -110,13 +110,25 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # Message describing Transport object
-  "createTime": "A String", # Output only. [Output only] Create time stamp
-  "labels": { # Optional. Labels as key value pairs
+{ # Message describing Transport object.
+  "adminEnabled": True or False, # Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity.
+  "advertisedRoutes": "A String", # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.
+  "bandwidth": "A String", # Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.
+  "createTime": "A String", # Output only. [Output only] Create time stamp.
+  "description": "A String", # Optional. Description of the Transport.
+  "generatedActivationKey": "A String", # Output only. [Output only] Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state.
+  "labels": { # Optional. Labels as key value pairs.
     "a_key": "A String",
   },
-  "name": "A String", # Identifier. name of resource
-  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "mtuLimit": 42, # Output only. [Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport.
+  "name": "A String", # Identifier. Name of the resource, see google.aip.dev/122 for resource naming.
+  "network": "A String", # Required. [Preview only] Resource URL of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.
+  "providedActivationKey": "A String", # Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.
+  "region": "A String", # Required. GCP Region where this Transport is located.
+  "remoteProfile": "A String", # Required. Resource URL of the remoteTransportProfile that this Transport is connecting to. Format: projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}
+  "stackType": "A String", # Optional. IP version stack for the established connectivity.
+  "state": "A String", # Output only. [Output only] State of the underlying connectivity.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp.
 }
 
   requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@@ -155,7 +167,7 @@ 
Method Details

   
Deletes a single Transport.
 
 Args:
-  name: string, Required. Name of the resource (required)
+  name: string, Required. Name of the resource. (required)
   requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
   x__xgafv: string, V1 error format.
     Allowed values
@@ -191,7 +203,7 @@ 
Method Details

   
Gets details of a single Transport.
 
 Args:
-  name: string, Required. Name of the resource (required)
+  name: string, Required. Name of the resource. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -200,13 +212,25 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # Message describing Transport object
-  "createTime": "A String", # Output only. [Output only] Create time stamp
-  "labels": { # Optional. Labels as key value pairs
+    { # Message describing Transport object.
+  "adminEnabled": True or False, # Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity.
+  "advertisedRoutes": "A String", # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.
+  "bandwidth": "A String", # Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.
+  "createTime": "A String", # Output only. [Output only] Create time stamp.
+  "description": "A String", # Optional. Description of the Transport.
+  "generatedActivationKey": "A String", # Output only. [Output only] Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state.
+  "labels": { # Optional. Labels as key value pairs.
     "a_key": "A String",
   },
-  "name": "A String", # Identifier. name of resource
-  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "mtuLimit": 42, # Output only. [Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport.
+  "name": "A String", # Identifier. Name of the resource, see google.aip.dev/122 for resource naming.
+  "network": "A String", # Required. [Preview only] Resource URL of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.
+  "providedActivationKey": "A String", # Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.
+  "region": "A String", # Required. GCP Region where this Transport is located.
+  "remoteProfile": "A String", # Required. Resource URL of the remoteTransportProfile that this Transport is connecting to. Format: projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}
+  "stackType": "A String", # Optional. IP version stack for the established connectivity.
+  "state": "A String", # Output only. [Output only] State of the underlying connectivity.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp.
 }

 

 
@@ -215,9 +239,9 @@ 
Method Details

   
Lists Transports in a given project and location.
 
 Args:
-  parent: string, Required. Parent value for ListTransportsRequest (required)
-  filter: string, Optional. Filtering results
-  orderBy: string, Optional. Hint for how to order the results
+  parent: string, Required. Parent value for ListTransportsRequest. (required)
+  filter: string, Optional. Filtering results.
+  orderBy: string, Optional. Hint for how to order the results.
   pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
   pageToken: string, Optional. A token identifying a page of results the server should return.
   x__xgafv: string, V1 error format.
@@ -228,16 +252,28 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # Message for response to listing Transports
+    { # Message for response to listing Transports.
   "nextPageToken": "A String", # A token identifying a page of results the server should return.
-  "transports": [ # The list of Transport
-    { # Message describing Transport object
-      "createTime": "A String", # Output only. [Output only] Create time stamp
-      "labels": { # Optional. Labels as key value pairs
+  "transports": [ # The list of Transport.
+    { # Message describing Transport object.
+      "adminEnabled": True or False, # Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity.
+      "advertisedRoutes": "A String", # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.
+      "bandwidth": "A String", # Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.
+      "createTime": "A String", # Output only. [Output only] Create time stamp.
+      "description": "A String", # Optional. Description of the Transport.
+      "generatedActivationKey": "A String", # Output only. [Output only] Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state.
+      "labels": { # Optional. Labels as key value pairs.
         "a_key": "A String",
       },
-      "name": "A String", # Identifier. name of resource
-      "updateTime": "A String", # Output only. [Output only] Update time stamp
+      "mtuLimit": 42, # Output only. [Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport.
+      "name": "A String", # Identifier. Name of the resource, see google.aip.dev/122 for resource naming.
+      "network": "A String", # Required. [Preview only] Resource URL of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.
+      "providedActivationKey": "A String", # Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.
+      "region": "A String", # Required. GCP Region where this Transport is located.
+      "remoteProfile": "A String", # Required. Resource URL of the remoteTransportProfile that this Transport is connecting to. Format: projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}
+      "stackType": "A String", # Optional. IP version stack for the established connectivity.
+      "state": "A String", # Output only. [Output only] State of the underlying connectivity.
+      "updateTime": "A String", # Output only. [Output only] Update time stamp.
     },
   ],
   "unreachable": [ # Unordered list. Locations that could not be reached.
@@ -265,17 +301,29 @@ 
Method Details

   
Updates the parameters of a single Transport.
 
 Args:
-  name: string, Identifier. name of resource (required)
+  name: string, Identifier. Name of the resource, see google.aip.dev/122 for resource naming. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Message describing Transport object
-  "createTime": "A String", # Output only. [Output only] Create time stamp
-  "labels": { # Optional. Labels as key value pairs
+{ # Message describing Transport object.
+  "adminEnabled": True or False, # Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity.
+  "advertisedRoutes": "A String", # Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.
+  "bandwidth": "A String", # Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.
+  "createTime": "A String", # Output only. [Output only] Create time stamp.
+  "description": "A String", # Optional. Description of the Transport.
+  "generatedActivationKey": "A String", # Output only. [Output only] Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state.
+  "labels": { # Optional. Labels as key value pairs.
     "a_key": "A String",
   },
-  "name": "A String", # Identifier. name of resource
-  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "mtuLimit": 42, # Output only. [Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport.
+  "name": "A String", # Identifier. Name of the resource, see google.aip.dev/122 for resource naming.
+  "network": "A String", # Required. [Preview only] Resource URL of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.
+  "providedActivationKey": "A String", # Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.
+  "region": "A String", # Required. GCP Region where this Transport is located.
+  "remoteProfile": "A String", # Required. Resource URL of the remoteTransportProfile that this Transport is connecting to. Format: projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}
+  "stackType": "A String", # Optional. IP version stack for the established connectivity.
+  "state": "A String", # Output only. [Output only] State of the underlying connectivity.
+  "updateTime": "A String", # Output only. [Output only] Update time stamp.
 }
 
   requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
diff --git a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.html b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.html
index b06f60cd3fb..140acf8b79a 100644
--- a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.html
+++ b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.html
@@ -145,7 +145,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json
index fb576072de4..c4b8160e826 100644
--- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json
+++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -2269,7 +2269,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. Name of the resource",
+"description": "Required. Name of the resource.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/remoteTransportProfiles/[^/]+$",
 "required": true,
@@ -2294,12 +2294,12 @@
 ],
 "parameters": {
 "filter": {
-"description": "Optional. Filtering results",
+"description": "Optional. Filtering results.",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "Optional. Hint for how to order the results",
+"description": "Optional. Hint for how to order the results.",
 "location": "query",
 "type": "string"
 },
@@ -2315,7 +2315,7 @@
 "type": "string"
 },
 "parent": {
-"description": "Required. Parent value for ListRemoteTransportProfilesRequest",
+"description": "Required. Parent value for ListRemoteTransportProfilesRequest.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
@@ -3626,7 +3626,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. Name of the resource",
+"description": "Required. Name of the resource.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/transports/[^/]+$",
 "required": true,
@@ -3656,7 +3656,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. Name of the resource",
+"description": "Required. Name of the resource.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/transports/[^/]+$",
 "required": true,
@@ -3681,12 +3681,12 @@
 ],
 "parameters": {
 "filter": {
-"description": "Optional. Filtering results",
+"description": "Optional. Filtering results.",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "Optional. Hint for how to order the results",
+"description": "Optional. Hint for how to order the results.",
 "location": "query",
 "type": "string"
 },
@@ -3702,7 +3702,7 @@
 "type": "string"
 },
 "parent": {
-"description": "Required. Parent value for ListTransportsRequest",
+"description": "Required. Parent value for ListTransportsRequest.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
@@ -3727,7 +3727,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Identifier. name of resource",
+"description": "Identifier. Name of the resource, see google.aip.dev/122 for resource naming.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+/transports/[^/]+$",
 "required": true,
@@ -3763,7 +3763,7 @@
 }
 }
 },
-"revision": "20250829",
+"revision": "20250910",
 "rootUrl": "https://networkconnectivity.googleapis.com/",
 "schemas": {
 "AcceptHubSpokeRequest": {
@@ -5202,7 +5202,7 @@
 "type": "string"
 },
 "remoteTransportProfiles": {
-"description": "The list of RemoteTransportProfiles",
+"description": "The list of RemoteTransportProfiles.",
 "items": {
 "$ref": "RemoteTransportProfile"
 },
@@ -5394,7 +5394,7 @@
 "type": "object"
 },
 "ListTransportsResponse": {
-"description": "Message for response to listing Transports",
+"description": "Message for response to listing Transports.",
 "id": "ListTransportsResponse",
 "properties": {
 "nextPageToken": {
@@ -5402,7 +5402,7 @@
 "type": "string"
 },
 "transports": {
-"description": "The list of Transport",
+"description": "The list of Transport.",
 "items": {
 "$ref": "Transport"
 },
@@ -6182,28 +6182,130 @@
 "type": "object"
 },
 "RemoteTransportProfile": {
-"description": "Message describing RemoteTransportProfile object",
+"description": "Message describing RemoteTransportProfile object.",
 "id": "RemoteTransportProfile",
 "properties": {
 "createTime": {
-"description": "Output only. [Output only] Create time stamp",
+"description": "Output only. [Output only] Create time stamp.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
 },
+"description": {
+"description": "Output only. Description of the profile.",
+"readOnly": true,
+"type": "string"
+},
+"flow": {
+"description": "Output only. [Output only] Type of provisioning flows supported by this profile.",
+"enum": [
+"KEY_PROVISIONING_FLOW_UNSPECIFIED",
+"INPUT_ONLY",
+"OUTPUT_ONLY",
+"INPUT_OR_OUTPUT"
+],
+"enumDescriptions": [
+"Unspecified key provisioning flow.",
+"The activationKey field on the Transport must be included in a create or patch request to establish connectivity.",
+"The generatedActivationKey field is populated and must be read from the resource and passed into the other provider.",
+"Both activation key fields are allowed for establishing connectivity. If a key is input, the generated key is still present after provisioning is finished."
+],
+"readOnly": true,
+"type": "string"
+},
 "labels": {
 "additionalProperties": {
 "type": "string"
 },
-"description": "Optional. Labels as key value pairs",
+"description": "Output only. Labels as key value pairs.",
+"readOnly": true,
 "type": "object"
 },
 "name": {
-"description": "Identifier. name of resource",
+"description": "Identifier. Name of the resource in the format of $provider-$site.",
+"type": "string"
+},
+"orderState": {
+"description": "Output only. [Output only] Order state for this profile.",
+"enum": [
+"STATE_UNSPECIFIED",
+"CLOSED",
+"OPEN"
+],
+"enumDescriptions": [
+"Unspecified state.",
+"Not enough capacity for customers to order.",
+"Enough capacity to fulfill an order."
+],
+"readOnly": true,
+"type": "string"
+},
+"provider": {
+"description": "Output only. Name of the provider on the other end of this profile. E.g. \u201cAmazon Web Services\u201d or \u201cMicrosoft Azure\u201d.",
+"readOnly": true,
+"type": "string"
+},
+"providerSite": {
+"description": "Output only. If the profile is a Cloud Service Provider with compute resources, this is populated with the region where connectivity is being established. If the profile provides facility-level selection, this is an identity of the facility any connections on this profile are going through.",
+"readOnly": true,
+"type": "string"
+},
+"region": {
+"description": "Output only. GCP Region where this profile is available.",
+"readOnly": true,
+"type": "string"
+},
+"sla": {
+"description": "Output only. [Output only] Availability class that will be configured for this particular RemoteTransportProfile.",
+"enum": [
+"SERVICE_LEVEL_AVAILABILITY_UNSPECIFIED",
+"HIGH",
+"MAXIMUM"
+],
+"enumDescriptions": [
+"Unspecified service level availability.",
+"This represents a 99.9% service level on the availability of the configured connectivity.",
+"This represents a 99.99% service level on the availability of the configured connectivity."
+],
+"readOnly": true,
+"type": "string"
+},
+"supportedBandwidths": {
+"description": "Output only. List of bandwidth enum values that are supported by this profile.",
+"items": {
+"enum": [
+"BANDWIDTH_UNSPECIFIED",
+"BPS_50M",
+"BPS_100M",
+"BPS_200M",
+"BPS_300M",
+"BPS_400M",
+"BPS_500M",
+"BPS_1G",
+"BPS_2G",
+"BPS_5G",
+"BPS_10G"
+],
+"enumDescriptions": [
+"Unspecified bandwidth.",
+"50 Megabits per second.",
+"100 Megabits per second.",
+"200 Megabits per second.",
+"300 Megabits per second.",
+"400 Megabits per second.",
+"500 Megabits per second.",
+"1 Gigabit per second.",
+"2 Gigabits per second.",
+"5 Gigabits per second.",
+"10 Gigabits per second."
+],
 "type": "string"
 },
+"readOnly": true,
+"type": "array"
+},
 "updateTime": {
-"description": "Output only. [Output only] Update time stamp",
+"description": "Output only. [Output only] Update time stamp.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
@@ -7135,28 +7237,130 @@
 "type": "object"
 },
 "Transport": {
-"description": "Message describing Transport object",
+"description": "Message describing Transport object.",
 "id": "Transport",
 "properties": {
+"adminEnabled": {
+"description": "Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity.",
+"type": "boolean"
+},
+"advertisedRoutes": {
+"description": "Optional. [Preview only] List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.",
+"type": "string"
+},
+"bandwidth": {
+"description": "Required. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile.",
+"enum": [
+"BANDWIDTH_UNSPECIFIED",
+"BPS_50M",
+"BPS_100M",
+"BPS_200M",
+"BPS_300M",
+"BPS_400M",
+"BPS_500M",
+"BPS_1G",
+"BPS_2G",
+"BPS_5G",
+"BPS_10G"
+],
+"enumDescriptions": [
+"Unspecified bandwidth.",
+"50 Megabits per second.",
+"100 Megabits per second.",
+"200 Megabits per second.",
+"300 Megabits per second.",
+"400 Megabits per second.",
+"500 Megabits per second.",
+"1 Gigabit per second.",
+"2 Gigabits per second.",
+"5 Gigabits per second.",
+"10 Gigabits per second."
+],
+"type": "string"
+},
 "createTime": {
-"description": "Output only. [Output only] Create time stamp",
+"description": "Output only. [Output only] Create time stamp.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
 },
+"description": {
+"description": "Optional. Description of the Transport.",
+"type": "string"
+},
+"generatedActivationKey": {
+"description": "Output only. [Output only] Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state.",
+"readOnly": true,
+"type": "string"
+},
 "labels": {
 "additionalProperties": {
 "type": "string"
 },
-"description": "Optional. Labels as key value pairs",
+"description": "Optional. Labels as key value pairs.",
 "type": "object"
 },
+"mtuLimit": {
+"description": "Output only. [Output only] The maximum transmission unit (MTU) of a packet that can be sent over this transport.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
 "name": {
-"description": "Identifier. name of resource",
+"description": "Identifier. Name of the resource, see google.aip.dev/122 for resource naming.",
+"type": "string"
+},
+"network": {
+"description": "Required. [Preview only] Resource URL of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.",
+"type": "string"
+},
+"providedActivationKey": {
+"description": "Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.",
+"type": "string"
+},
+"region": {
+"description": "Required. GCP Region where this Transport is located.",
+"type": "string"
+},
+"remoteProfile": {
+"description": "Required. Resource URL of the remoteTransportProfile that this Transport is connecting to. Format: projects/{project}/locations/{location}/remoteTransportProfiles/{remote_transport_profile}",
+"type": "string"
+},
+"stackType": {
+"description": "Optional. IP version stack for the established connectivity.",
+"enum": [
+"STACK_TYPE_UNSPECIFIED",
+"IPV4_ONLY",
+"IPV4_IPV6"
+],
+"enumDescriptions": [
+"Unspecified stack type.",
+"Only IPv4 is supported. (default)",
+"Both IPv4 and IPv6 are supported."
+],
+"type": "string"
+},
+"state": {
+"description": "Output only. [Output only] State of the underlying connectivity.",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"PENDING_CONFIG",
+"PENDING_KEY",
+"ACTIVE"
+],
+"enumDescriptions": [
+"Unspecified state.",
+"The resource exists locally and is being created / associated with the resource on the remote provider\u2019s end of the underlying connectivity.",
+"The Transport exists on both sides of the connection, and is waiting for configuration to finalize and be verified as operational.",
+"The Transport was created in GCP. Depending on the profile\u2019s key provisioning flow, this is either waiting for an activation key to be input (the key will be validated that it uses remote resources that match the Transport), or for the generated key to be input to the provider for finalizing. The configured bandwidth is not yet guaranteed.",
+"The Transport is configured and the underlying connectivity is considered operational."
+],
+"readOnly": true,
 "type": "string"
 },
 "updateTime": {
-"description": "Output only. [Output only] Update time stamp",
+"description": "Output only. [Output only] Update time stamp.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json
index be37c182df7..efeb4254ca7 100644
--- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1122,7 +1122,7 @@
 }
 }
 },
-"revision": "20250815",
+"revision": "20250910",
 "rootUrl": "https://networkconnectivity.googleapis.com/",
 "schemas": {
 "AllocationOptions": {

From db1452ba34c8d8e4cae5c30046993449db6fa336 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:09 +0000
Subject: [PATCH 21/26] feat(networksecurity): update the api

#### networksecurity:v1beta1

The following keys were added:
- schemas.MirroringEndpointGroup.properties.type.type (Total Keys: 1)
---
 ...y_v1.projects.locations.authzPolicies.html | 16 +++++++--------
 ...networksecurity_v1.projects.locations.html |  2 +-
 ...eta1.projects.locations.authzPolicies.html | 16 +++++++--------
 ...rksecurity_v1beta1.projects.locations.html |  2 +-
 ...cts.locations.mirroringEndpointGroups.html |  4 ++++
 .../documents/networksecurity.v1.json         |  8 ++++----
 .../documents/networksecurity.v1beta1.json    | 20 +++++++++++++++----
 7 files changed, 42 insertions(+), 26 deletions(-)

diff --git a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html
index db234965003..94747d16144 100644
--- a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html
+++ b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html
@@ -143,7 +143,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -181,7 +181,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -413,7 +413,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -451,7 +451,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -671,7 +671,7 @@ 
Method Details

                     "prefix": "A String", # Required. The address prefix.
                   },
                 ],
-                "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+                "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
                   { # Describes the properties of a principal to be matched against.
                     "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                       "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -709,7 +709,7 @@ 
Method Details

                     "prefix": "A String", # Required. The address prefix.
                   },
                 ],
-                "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+                "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
                   { # Describes the properties of a principal to be matched against.
                     "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                       "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -890,7 +890,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -928,7 +928,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
diff --git a/docs/dyn/networksecurity_v1.projects.locations.html b/docs/dyn/networksecurity_v1.projects.locations.html
index afb64d911e4..f828b5d1459 100644
--- a/docs/dyn/networksecurity_v1.projects.locations.html
+++ b/docs/dyn/networksecurity_v1.projects.locations.html
@@ -220,7 +220,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html
index 322f55f054c..8eea6d4ea16 100644
--- a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html
+++ b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html
@@ -143,7 +143,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -181,7 +181,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -413,7 +413,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -451,7 +451,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -671,7 +671,7 @@ 
Method Details

                     "prefix": "A String", # Required. The address prefix.
                   },
                 ],
-                "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+                "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
                   { # Describes the properties of a principal to be matched against.
                     "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                       "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -709,7 +709,7 @@ 
Method Details

                     "prefix": "A String", # Required. The address prefix.
                   },
                 ],
-                "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+                "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
                   { # Describes the properties of a principal to be matched against.
                     "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                       "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -890,7 +890,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
@@ -928,7 +928,7 @@ 
Method Details

                 "prefix": "A String", # Required. The address prefix.
               },
             ],
-            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.
               { # Describes the properties of a principal to be matched against.
                 "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors.
                   "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.html b/docs/dyn/networksecurity_v1beta1.projects.locations.html
index 53105c10882..2d6b18b252e 100644
--- a/docs/dyn/networksecurity_v1beta1.projects.locations.html
+++ b/docs/dyn/networksecurity_v1beta1.projects.locations.html
@@ -235,7 +235,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringEndpointGroups.html b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringEndpointGroups.html
index 4aae1511801..5ce822a67fa 100644
--- a/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringEndpointGroups.html
+++ b/docs/dyn/networksecurity_v1beta1.projects.locations.mirroringEndpointGroups.html
@@ -138,6 +138,7 @@ 
Method Details

   "name": "A String", # Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.
   "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.
   "state": "A String", # Output only. The current state of the endpoint group. See https://google.aip.dev/216.
+  "type": "A String", # Immutable. The type of the endpoint group. If left unspecified, defaults to DIRECT.
   "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
 }
 
@@ -250,6 +251,7 @@ 
Method Details

   "name": "A String", # Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.
   "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.
   "state": "A String", # Output only. The current state of the endpoint group. See https://google.aip.dev/216.
+  "type": "A String", # Immutable. The type of the endpoint group. If left unspecified, defaults to DIRECT.
   "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
 }

 

@@ -302,6 +304,7 @@ 
Method Details

       "name": "A String", # Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.
       "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.
       "state": "A String", # Output only. The current state of the endpoint group. See https://google.aip.dev/216.
+      "type": "A String", # Immutable. The type of the endpoint group. If left unspecified, defaults to DIRECT.
       "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
     },
   ],
@@ -360,6 +363,7 @@ 
Method Details

   "name": "A String", # Immutable. Identifier. The resource name of this endpoint group, for example: `projects/123456789/locations/global/mirroringEndpointGroups/my-eg`. See https://google.aip.dev/122 for more details.
   "reconciling": True or False, # Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.
   "state": "A String", # Output only. The current state of the endpoint group. See https://google.aip.dev/216.
+  "type": "A String", # Immutable. The type of the endpoint group. If left unspecified, defaults to DIRECT.
   "updateTime": "A String", # Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.
 }
 
diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json
index 3b631c930c7..eac903a216b 100644
--- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json
+++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json
@@ -1078,7 +1078,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -5070,7 +5070,7 @@
 }
 }
 },
-"revision": "20250822",
+"revision": "20250911",
 "rootUrl": "https://networksecurity.googleapis.com/",
 "schemas": {
 "AddAddressGroupItemsRequest": {
@@ -5394,7 +5394,7 @@
 "type": "array"
 },
 "principals": {
-"description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.",
+"description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.",
 "items": {
 "$ref": "AuthzPolicyAuthzRulePrincipal"
 },
@@ -5461,7 +5461,7 @@
 "Unspecified principal selector. It will be treated as CLIENT_CERT_URI_SAN by default.",
 "The principal rule is matched against a list of URI SANs in the validated client's certificate. A match happens when there is any exact URI SAN value match. This is the default principal selector.",
 "The principal rule is matched against a list of DNS Name SANs in the validated client's certificate. A match happens when there is any exact DNS Name SAN value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_DNS_NAME_SAN is not supported for INTERNAL_SELF_MANAGED load balancing scheme.",
-"The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme."
+"The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for global external Application Load Balancer and classic Application Load Balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme."
 ],
 "type": "string"
 }
diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json
index d079015d127..1893c0a47be 100644
--- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json
@@ -1078,7 +1078,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -5513,7 +5513,7 @@
 }
 }
 },
-"revision": "20250903",
+"revision": "20250911",
 "rootUrl": "https://networksecurity.googleapis.com/",
 "schemas": {
 "AddAddressGroupItemsRequest": {
@@ -5837,7 +5837,7 @@
 "type": "array"
 },
 "principals": {
-"description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for Regional Internal Application Load Balancer, Regional External Application Load Balancer, Cross-region Internal Application Load Balancer, and Cloud Service Mesh. Limited to 25 principals per Authorization Policy for Global External Application Load Balancer.",
+"description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.",
 "items": {
 "$ref": "AuthzPolicyAuthzRulePrincipal"
 },
@@ -5904,7 +5904,7 @@
 "Unspecified principal selector. It will be treated as CLIENT_CERT_URI_SAN by default.",
 "The principal rule is matched against a list of URI SANs in the validated client's certificate. A match happens when there is any exact URI SAN value match. This is the default principal selector.",
 "The principal rule is matched against a list of DNS Name SANs in the validated client's certificate. A match happens when there is any exact DNS Name SAN value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_DNS_NAME_SAN is not supported for INTERNAL_SELF_MANAGED load balancing scheme.",
-"The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme."
+"The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for global external Application Load Balancer and classic Application Load Balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme."
 ],
 "type": "string"
 }
@@ -8282,6 +8282,18 @@
 "readOnly": true,
 "type": "string"
 },
+"type": {
+"description": "Immutable. The type of the endpoint group. If left unspecified, defaults to DIRECT.",
+"enum": [
+"TYPE_UNSPECIFIED",
+"DIRECT"
+],
+"enumDescriptions": [
+"Not set.",
+"An endpoint group that sends packets to a single deployment group."
+],
+"type": "string"
+},
 "updateTime": {
 "description": "Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps.",
 "format": "google-datetime",

From dc6914b7527d4f99e12ce6913a3bab787bb4297c Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:09 +0000
Subject: [PATCH 22/26] feat(oracledatabase): update the api

#### oracledatabase:v1

The following keys were added:
- resources.projects.resources.locations.resources.autonomousDatabases.methods.failover (Total Keys: 12)
- resources.projects.resources.locations.resources.exadbVmClusters.methods.create (Total Keys: 16)
- resources.projects.resources.locations.resources.exadbVmClusters.methods.delete (Total Keys: 13)
- resources.projects.resources.locations.resources.exadbVmClusters.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.exadbVmClusters.methods.list (Total Keys: 20)
- resources.projects.resources.locations.resources.exadbVmClusters.methods.patch (Total Keys: 17)
- resources.projects.resources.locations.resources.exadbVmClusters.methods.removeVirtualMachine (Total Keys: 12)
- resources.projects.resources.locations.resources.exascaleDbStorageVaults.methods.create (Total Keys: 16)
- resources.projects.resources.locations.resources.exascaleDbStorageVaults.methods.delete (Total Keys: 13)
- resources.projects.resources.locations.resources.exascaleDbStorageVaults.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.exascaleDbStorageVaults.methods.list (Total Keys: 20)
- resources.projects.resources.locations.resources.giVersions.resources.minorVersions.methods.list (Total Keys: 18)
- schemas.DataCollectionOptionsCommon (Total Keys: 5)
- schemas.ExadbVmCluster (Total Keys: 51)
- schemas.ExascaleDbStorageDetails (Total Keys: 7)
- schemas.ExascaleDbStorageVault (Total Keys: 36)
- schemas.FailoverAutonomousDatabaseRequest (Total Keys: 3)
- schemas.ListExadbVmClustersResponse (Total Keys: 5)
- schemas.ListExascaleDbStorageVaultsResponse (Total Keys: 5)
- schemas.ListMinorVersionsResponse (Total Keys: 5)
- schemas.MinorVersion (Total Keys: 5)
- schemas.RemoveVirtualMachineExadbVmClusterRequest (Total Keys: 5)
---
 ...rojects.locations.autonomousDatabases.html |   45 +
 ...v1.projects.locations.exadbVmClusters.html |  505 +++
 ...cts.locations.exascaleDbStorageVaults.html |  338 ++
 ...base_v1.projects.locations.giVersions.html |    5 +
 ...ts.locations.giVersions.minorVersions.html |  135 +
 .../oracledatabase_v1.projects.locations.html |   10 +
 .../documents/oracledatabase.v1.json          | 3636 +++++++++++------
 7 files changed, 3315 insertions(+), 1359 deletions(-)
 create mode 100644 docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html
 create mode 100644 docs/dyn/oracledatabase_v1.projects.locations.exascaleDbStorageVaults.html
 create mode 100644 docs/dyn/oracledatabase_v1.projects.locations.giVersions.minorVersions.html

diff --git a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html
index 031d40e9eb2..081fa86ce9f 100644
--- a/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html
+++ b/docs/dyn/oracledatabase_v1.projects.locations.autonomousDatabases.html
@@ -83,6 +83,9 @@ 
Instance Methods

 

   delete(name, requestId=None, x__xgafv=None)

 
Deletes a single Autonomous Database.

+

+  failover(name, body=None, x__xgafv=None)

+
Initiates a failover to target autonomous database from the associated primary database.

 

   generateWallet(name, body=None, x__xgafv=None)

 
Generates a wallet for an Autonomous Database.

@@ -349,6 +352,48 @@ 
Method Details

 }
+
+ failover(name, body=None, x__xgafv=None) + 
Initiates a failover to target autonomous database from the associated primary database.
+
+Args:
+  name: string, Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for `OracleDatabase.FailoverAutonomousDatabase`.
+  "peerAutonomousDatabase": "A String", # Required. The peer database name to fail over to.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
generateWallet(name, body=None, x__xgafv=None) 
Generates a wallet for an Autonomous Database.
diff --git a/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html b/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html
new file mode 100644
index 00000000000..ef83c2a8bf8
--- /dev/null
+++ b/docs/dyn/oracledatabase_v1.projects.locations.exadbVmClusters.html
@@ -0,0 +1,505 @@
+
+
+
+
Oracle Database@Google Cloud API . projects . locations . exadbVmClusters

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  create(parent, body=None, exadbVmClusterId=None, requestId=None, x__xgafv=None)

+
Creates a new Exadb (Exascale) VM Cluster resource.

+

+  delete(name, requestId=None, x__xgafv=None)

+
Deletes a single Exadb (Exascale) VM Cluster.

+

+  get(name, x__xgafv=None)

+
Gets details of a single Exadb (Exascale) VM Cluster.

+

+  list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists all the Exadb (Exascale) VM Clusters for the given project and location.

+

+  list_next()

+
Retrieves the next page of results.

+

+  patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

+
Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count.

+

+  removeVirtualMachine(name, body=None, x__xgafv=None)

+
Removes virtual machines from an existing exadb vm cluster.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    create(parent, body=None, exadbVmClusterId=None, requestId=None, x__xgafv=None)
+  
Creates a new Exadb (Exascale) VM Cluster resource.
+
+Args:
+  parent: string, Required. The value for parent of the ExadbVmCluster in the following format: projects/{project}/locations/{location}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/
+  "backupOdbSubnet": "A String", # Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
+  "createTime": "A String", # Output only. The date and time that the ExadbVmCluster was created.
+  "displayName": "A String", # Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.
+  "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.
+  "gcpOracleZone": "A String", # Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.
+  "labels": { # Optional. The labels or tags associated with the ExadbVmCluster.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}
+  "odbNetwork": "A String", # Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
+  "odbSubnet": "A String", # Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
+  "properties": { # The properties of an ExadbVmCluster. # Required. The properties of the ExadbVmCluster.
+    "additionalEcpuCountPerNode": 42, # Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure.
+    "clusterName": "A String", # Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name.
+    "dataCollectionOptions": { # Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions # Optional. Immutable. Indicates user preference for data collection options.
+      "isDiagnosticsEventsEnabled": True or False, # Optional. Indicates whether to enable data collection for diagnostics.
+      "isHealthMonitoringEnabled": True or False, # Optional. Indicates whether to enable health monitoring.
+      "isIncidentLogsEnabled": True or False, # Optional. Indicates whether to enable incident logs and trace collection.
+    },
+    "enabledEcpuCountPerNode": 42, # Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure.
+    "exascaleDbStorageVault": "A String", # Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
+    "giVersion": "A String", # Output only. The Oracle Grid Infrastructure (GI) software version.
+    "gridImageId": "A String", # Required. Immutable. Grid Infrastructure Version.
+    "hostname": "A String", # Output only. The hostname of the ExadbVmCluster.
+    "hostnamePrefix": "A String", # Required. Immutable. Prefix for VM cluster host names.
+    "licenseModel": "A String", # Optional. Immutable. The license type of the ExadbVmCluster.
+    "lifecycleState": "A String", # Output only. State of the cluster.
+    "memorySizeGb": 42, # Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs.
+    "nodeCount": 42, # Required. The number of nodes/VMs in the ExadbVmCluster.
+    "ociUri": "A String", # Output only. Deep link to the OCI console to view this resource.
+    "scanListenerPortTcp": 42, # Optional. Immutable. SCAN listener port - TCP
+    "shapeAttribute": "A String", # Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later
+    "sshPublicKeys": [ # Required. Immutable. The SSH public keys for the ExadbVmCluster.
+      "A String",
+    ],
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Optional. Immutable. The time zone of the ExadbVmCluster.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "vmFileSystemStorage": { # The storage allocation for the exadbvmcluster, in gigabytes (GB). # Required. Immutable. Total storage details for the ExadbVmCluster.
+      "sizeInGbsPerNode": 42, # Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster.
+    },
+  },
+}
+
+  exadbVmClusterId: string, Required. The ID of the ExadbVmCluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    delete(name, requestId=None, x__xgafv=None)
+  
Deletes a single Exadb (Exascale) VM Cluster.
+
+Args:
+  name: string, Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. (required)
+  requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    get(name, x__xgafv=None)
+  
Gets details of a single Exadb (Exascale) VM Cluster.
+
+Args:
+  name: string, Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/
+  "backupOdbSubnet": "A String", # Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
+  "createTime": "A String", # Output only. The date and time that the ExadbVmCluster was created.
+  "displayName": "A String", # Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.
+  "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.
+  "gcpOracleZone": "A String", # Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.
+  "labels": { # Optional. The labels or tags associated with the ExadbVmCluster.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}
+  "odbNetwork": "A String", # Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
+  "odbSubnet": "A String", # Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
+  "properties": { # The properties of an ExadbVmCluster. # Required. The properties of the ExadbVmCluster.
+    "additionalEcpuCountPerNode": 42, # Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure.
+    "clusterName": "A String", # Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name.
+    "dataCollectionOptions": { # Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions # Optional. Immutable. Indicates user preference for data collection options.
+      "isDiagnosticsEventsEnabled": True or False, # Optional. Indicates whether to enable data collection for diagnostics.
+      "isHealthMonitoringEnabled": True or False, # Optional. Indicates whether to enable health monitoring.
+      "isIncidentLogsEnabled": True or False, # Optional. Indicates whether to enable incident logs and trace collection.
+    },
+    "enabledEcpuCountPerNode": 42, # Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure.
+    "exascaleDbStorageVault": "A String", # Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
+    "giVersion": "A String", # Output only. The Oracle Grid Infrastructure (GI) software version.
+    "gridImageId": "A String", # Required. Immutable. Grid Infrastructure Version.
+    "hostname": "A String", # Output only. The hostname of the ExadbVmCluster.
+    "hostnamePrefix": "A String", # Required. Immutable. Prefix for VM cluster host names.
+    "licenseModel": "A String", # Optional. Immutable. The license type of the ExadbVmCluster.
+    "lifecycleState": "A String", # Output only. State of the cluster.
+    "memorySizeGb": 42, # Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs.
+    "nodeCount": 42, # Required. The number of nodes/VMs in the ExadbVmCluster.
+    "ociUri": "A String", # Output only. Deep link to the OCI console to view this resource.
+    "scanListenerPortTcp": 42, # Optional. Immutable. SCAN listener port - TCP
+    "shapeAttribute": "A String", # Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later
+    "sshPublicKeys": [ # Required. Immutable. The SSH public keys for the ExadbVmCluster.
+      "A String",
+    ],
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Optional. Immutable. The time zone of the ExadbVmCluster.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "vmFileSystemStorage": { # The storage allocation for the exadbvmcluster, in gigabytes (GB). # Required. Immutable. Total storage details for the ExadbVmCluster.
+      "sizeInGbsPerNode": 42, # Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster.
+    },
+  },
+}

+

+
+

+    list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists all the Exadb (Exascale) VM Clusters for the given project and location.
+
+Args:
+  parent: string, Required. The parent value for ExadbVmClusters in the following format: projects/{project}/locations/{location}. (required)
+  filter: string, Optional. An expression for filtering the results of the request.
+  orderBy: string, Optional. An expression for ordering the results of the request.
+  pageSize: integer, Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for `ExadbVmCluster.List`.
+  "exadbVmClusters": [ # The list of ExadbVmClusters.
+    { # ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/
+      "backupOdbSubnet": "A String", # Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
+      "createTime": "A String", # Output only. The date and time that the ExadbVmCluster was created.
+      "displayName": "A String", # Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.
+      "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.
+      "gcpOracleZone": "A String", # Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.
+      "labels": { # Optional. The labels or tags associated with the ExadbVmCluster.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}
+      "odbNetwork": "A String", # Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
+      "odbSubnet": "A String", # Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
+      "properties": { # The properties of an ExadbVmCluster. # Required. The properties of the ExadbVmCluster.
+        "additionalEcpuCountPerNode": 42, # Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure.
+        "clusterName": "A String", # Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name.
+        "dataCollectionOptions": { # Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions # Optional. Immutable. Indicates user preference for data collection options.
+          "isDiagnosticsEventsEnabled": True or False, # Optional. Indicates whether to enable data collection for diagnostics.
+          "isHealthMonitoringEnabled": True or False, # Optional. Indicates whether to enable health monitoring.
+          "isIncidentLogsEnabled": True or False, # Optional. Indicates whether to enable incident logs and trace collection.
+        },
+        "enabledEcpuCountPerNode": 42, # Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure.
+        "exascaleDbStorageVault": "A String", # Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
+        "giVersion": "A String", # Output only. The Oracle Grid Infrastructure (GI) software version.
+        "gridImageId": "A String", # Required. Immutable. Grid Infrastructure Version.
+        "hostname": "A String", # Output only. The hostname of the ExadbVmCluster.
+        "hostnamePrefix": "A String", # Required. Immutable. Prefix for VM cluster host names.
+        "licenseModel": "A String", # Optional. Immutable. The license type of the ExadbVmCluster.
+        "lifecycleState": "A String", # Output only. State of the cluster.
+        "memorySizeGb": 42, # Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs.
+        "nodeCount": 42, # Required. The number of nodes/VMs in the ExadbVmCluster.
+        "ociUri": "A String", # Output only. Deep link to the OCI console to view this resource.
+        "scanListenerPortTcp": 42, # Optional. Immutable. SCAN listener port - TCP
+        "shapeAttribute": "A String", # Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later
+        "sshPublicKeys": [ # Required. Immutable. The SSH public keys for the ExadbVmCluster.
+          "A String",
+        ],
+        "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Optional. Immutable. The time zone of the ExadbVmCluster.
+          "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+          "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+        },
+        "vmFileSystemStorage": { # The storage allocation for the exadbvmcluster, in gigabytes (GB). # Required. Immutable. Total storage details for the ExadbVmCluster.
+          "sizeInGbsPerNode": 42, # Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster.
+        },
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+

+    patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
+  
Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count.
+
+Args:
+  name: string, Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/
+  "backupOdbSubnet": "A String", # Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
+  "createTime": "A String", # Output only. The date and time that the ExadbVmCluster was created.
+  "displayName": "A String", # Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.
+  "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.
+  "gcpOracleZone": "A String", # Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.
+  "labels": { # Optional. The labels or tags associated with the ExadbVmCluster.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}
+  "odbNetwork": "A String", # Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
+  "odbSubnet": "A String", # Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
+  "properties": { # The properties of an ExadbVmCluster. # Required. The properties of the ExadbVmCluster.
+    "additionalEcpuCountPerNode": 42, # Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure.
+    "clusterName": "A String", # Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name.
+    "dataCollectionOptions": { # Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions # Optional. Immutable. Indicates user preference for data collection options.
+      "isDiagnosticsEventsEnabled": True or False, # Optional. Indicates whether to enable data collection for diagnostics.
+      "isHealthMonitoringEnabled": True or False, # Optional. Indicates whether to enable health monitoring.
+      "isIncidentLogsEnabled": True or False, # Optional. Indicates whether to enable incident logs and trace collection.
+    },
+    "enabledEcpuCountPerNode": 42, # Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure.
+    "exascaleDbStorageVault": "A String", # Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
+    "giVersion": "A String", # Output only. The Oracle Grid Infrastructure (GI) software version.
+    "gridImageId": "A String", # Required. Immutable. Grid Infrastructure Version.
+    "hostname": "A String", # Output only. The hostname of the ExadbVmCluster.
+    "hostnamePrefix": "A String", # Required. Immutable. Prefix for VM cluster host names.
+    "licenseModel": "A String", # Optional. Immutable. The license type of the ExadbVmCluster.
+    "lifecycleState": "A String", # Output only. State of the cluster.
+    "memorySizeGb": 42, # Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs.
+    "nodeCount": 42, # Required. The number of nodes/VMs in the ExadbVmCluster.
+    "ociUri": "A String", # Output only. Deep link to the OCI console to view this resource.
+    "scanListenerPortTcp": 42, # Optional. Immutable. SCAN listener port - TCP
+    "shapeAttribute": "A String", # Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later
+    "sshPublicKeys": [ # Required. Immutable. The SSH public keys for the ExadbVmCluster.
+      "A String",
+    ],
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Optional. Immutable. The time zone of the ExadbVmCluster.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "vmFileSystemStorage": { # The storage allocation for the exadbvmcluster, in gigabytes (GB). # Required. Immutable. Total storage details for the ExadbVmCluster.
+      "sizeInGbsPerNode": 42, # Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster.
+    },
+  },
+}
+
+  requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    removeVirtualMachine(name, body=None, x__xgafv=None)
+  
Removes virtual machines from an existing exadb vm cluster.
+
+Args:
+  name: string, Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request for `ExadbVmCluster.RemoveVirtualMachine`.
+  "hostnames": [ # Required. The list of host names of db nodes to be removed from the ExadbVmCluster.
+    "A String",
+  ],
+  "requestId": "A String", # Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/oracledatabase_v1.projects.locations.exascaleDbStorageVaults.html b/docs/dyn/oracledatabase_v1.projects.locations.exascaleDbStorageVaults.html
new file mode 100644
index 00000000000..57cee278fce
--- /dev/null
+++ b/docs/dyn/oracledatabase_v1.projects.locations.exascaleDbStorageVaults.html
@@ -0,0 +1,338 @@
+
+
+
+
Oracle Database@Google Cloud API . projects . locations . exascaleDbStorageVaults

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  create(parent, body=None, exascaleDbStorageVaultId=None, requestId=None, x__xgafv=None)

+
Creates a new ExascaleDB Storage Vault resource.

+

+  delete(name, requestId=None, x__xgafv=None)

+
Deletes a single ExascaleDB Storage Vault.

+

+  get(name, x__xgafv=None)

+
Gets details of a single ExascaleDB Storage Vault.

+

+  list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists all the ExascaleDB Storage Vaults for the given project and location.

+

+  list_next()

+
Retrieves the next page of results.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    create(parent, body=None, exascaleDbStorageVaultId=None, requestId=None, x__xgafv=None)
+  
Creates a new ExascaleDB Storage Vault resource.
+
+Args:
+  parent: string, Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/
+  "createTime": "A String", # Output only. The date and time when the ExascaleDbStorageVault was created.
+  "displayName": "A String", # Required. The display name for the ExascaleDbStorageVault. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.
+  "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExascaleDbStorageVault.
+  "gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
+  "labels": { # Optional. The labels or tags associated with the ExascaleDbStorageVault.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the ExascaleDbStorageVault. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
+  "properties": { # The properties of the ExascaleDbStorageVault. next ID: 12 # Required. The properties of the ExascaleDbStorageVault.
+    "additionalFlashCachePercent": 42, # Optional. The size of additional flash cache in percentage of high capacity database storage.
+    "attachedShapeAttributes": [ # Output only. The shape attributes of the VM clusters attached to the ExascaleDbStorageVault.
+      "A String",
+    ],
+    "availableShapeAttributes": [ # Output only. The shape attributes available for the VM clusters to be attached to the ExascaleDbStorageVault.
+      "A String",
+    ],
+    "description": "A String", # Optional. The description of the ExascaleDbStorageVault.
+    "exascaleDbStorageDetails": { # The storage details of the ExascaleDbStorageVault. # Required. The storage details of the ExascaleDbStorageVault.
+      "availableSizeGbs": 42, # Output only. The available storage capacity for the ExascaleDbStorageVault, in gigabytes (GB).
+      "totalSizeGbs": 42, # Required. The total storage allocation for the ExascaleDbStorageVault, in gigabytes (GB).
+    },
+    "ociUri": "A String", # Output only. Deep link to the OCI console to view this resource.
+    "ocid": "A String", # Output only. The OCID for the ExascaleDbStorageVault.
+    "state": "A String", # Output only. The state of the ExascaleDbStorageVault.
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. The time zone of the ExascaleDbStorageVault.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "vmClusterCount": 42, # Output only. The number of VM clusters associated with the ExascaleDbStorageVault.
+    "vmClusterIds": [ # Output only. The list of VM cluster OCIDs associated with the ExascaleDbStorageVault.
+      "A String",
+    ],
+  },
+}
+
+  exascaleDbStorageVaultId: string, Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    delete(name, requestId=None, x__xgafv=None)
+  
Deletes a single ExascaleDB Storage Vault.
+
+Args:
+  name: string, Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}. (required)
+  requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}

+

+
+

+    get(name, x__xgafv=None)
+  
Gets details of a single ExascaleDB Storage Vault.
+
+Args:
+  name: string, Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/
+  "createTime": "A String", # Output only. The date and time when the ExascaleDbStorageVault was created.
+  "displayName": "A String", # Required. The display name for the ExascaleDbStorageVault. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.
+  "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExascaleDbStorageVault.
+  "gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
+  "labels": { # Optional. The labels or tags associated with the ExascaleDbStorageVault.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the ExascaleDbStorageVault. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
+  "properties": { # The properties of the ExascaleDbStorageVault. next ID: 12 # Required. The properties of the ExascaleDbStorageVault.
+    "additionalFlashCachePercent": 42, # Optional. The size of additional flash cache in percentage of high capacity database storage.
+    "attachedShapeAttributes": [ # Output only. The shape attributes of the VM clusters attached to the ExascaleDbStorageVault.
+      "A String",
+    ],
+    "availableShapeAttributes": [ # Output only. The shape attributes available for the VM clusters to be attached to the ExascaleDbStorageVault.
+      "A String",
+    ],
+    "description": "A String", # Optional. The description of the ExascaleDbStorageVault.
+    "exascaleDbStorageDetails": { # The storage details of the ExascaleDbStorageVault. # Required. The storage details of the ExascaleDbStorageVault.
+      "availableSizeGbs": 42, # Output only. The available storage capacity for the ExascaleDbStorageVault, in gigabytes (GB).
+      "totalSizeGbs": 42, # Required. The total storage allocation for the ExascaleDbStorageVault, in gigabytes (GB).
+    },
+    "ociUri": "A String", # Output only. Deep link to the OCI console to view this resource.
+    "ocid": "A String", # Output only. The OCID for the ExascaleDbStorageVault.
+    "state": "A String", # Output only. The state of the ExascaleDbStorageVault.
+    "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. The time zone of the ExascaleDbStorageVault.
+      "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+    },
+    "vmClusterCount": 42, # Output only. The number of VM clusters associated with the ExascaleDbStorageVault.
+    "vmClusterIds": [ # Output only. The list of VM cluster OCIDs associated with the ExascaleDbStorageVault.
+      "A String",
+    ],
+  },
+}

+

+
+

+    list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists all the ExascaleDB Storage Vaults for the given project and location.
+
+Args:
+  parent: string, Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}. (required)
+  filter: string, Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160.
+  orderBy: string, Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132.
+  pageSize: integer, Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A token identifying a page of results the server should return.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for `ExascaleDbStorageVault.List`.
+  "exascaleDbStorageVaults": [ # The ExascaleDbStorageVaults.
+    { # ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/
+      "createTime": "A String", # Output only. The date and time when the ExascaleDbStorageVault was created.
+      "displayName": "A String", # Required. The display name for the ExascaleDbStorageVault. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.
+      "entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the ExascaleDbStorageVault.
+      "gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
+      "labels": { # Optional. The labels or tags associated with the ExascaleDbStorageVault.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the ExascaleDbStorageVault. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}
+      "properties": { # The properties of the ExascaleDbStorageVault. next ID: 12 # Required. The properties of the ExascaleDbStorageVault.
+        "additionalFlashCachePercent": 42, # Optional. The size of additional flash cache in percentage of high capacity database storage.
+        "attachedShapeAttributes": [ # Output only. The shape attributes of the VM clusters attached to the ExascaleDbStorageVault.
+          "A String",
+        ],
+        "availableShapeAttributes": [ # Output only. The shape attributes available for the VM clusters to be attached to the ExascaleDbStorageVault.
+          "A String",
+        ],
+        "description": "A String", # Optional. The description of the ExascaleDbStorageVault.
+        "exascaleDbStorageDetails": { # The storage details of the ExascaleDbStorageVault. # Required. The storage details of the ExascaleDbStorageVault.
+          "availableSizeGbs": 42, # Output only. The available storage capacity for the ExascaleDbStorageVault, in gigabytes (GB).
+          "totalSizeGbs": 42, # Required. The total storage allocation for the ExascaleDbStorageVault, in gigabytes (GB).
+        },
+        "ociUri": "A String", # Output only. Deep link to the OCI console to view this resource.
+        "ocid": "A String", # Output only. The OCID for the ExascaleDbStorageVault.
+        "state": "A String", # Output only. The state of the ExascaleDbStorageVault.
+        "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. The time zone of the ExascaleDbStorageVault.
+          "id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
+          "version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
+        },
+        "vmClusterCount": 42, # Output only. The number of VM clusters associated with the ExascaleDbStorageVault.
+        "vmClusterIds": [ # Output only. The list of VM cluster OCIDs associated with the ExascaleDbStorageVault.
+          "A String",
+        ],
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return. If present, the next page token can be provided to a subsequent ListExascaleDbStorageVaults call to list the next page. If empty, there are no more pages.
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/oracledatabase_v1.projects.locations.giVersions.html b/docs/dyn/oracledatabase_v1.projects.locations.giVersions.html
index 9232b21131c..10e16ee99f6 100644
--- a/docs/dyn/oracledatabase_v1.projects.locations.giVersions.html
+++ b/docs/dyn/oracledatabase_v1.projects.locations.giVersions.html
@@ -74,6 +74,11 @@
 
 
Oracle Database@Google Cloud API . projects . locations . giVersions

 
Instance Methods

+

+  minorVersions()
+

+
Returns the minorVersions Resource.

+
 

   close()

 
Close httplib2 connections.

diff --git a/docs/dyn/oracledatabase_v1.projects.locations.giVersions.minorVersions.html b/docs/dyn/oracledatabase_v1.projects.locations.giVersions.minorVersions.html
new file mode 100644
index 00000000000..5db9586bd76
--- /dev/null
+++ b/docs/dyn/oracledatabase_v1.projects.locations.giVersions.minorVersions.html
@@ -0,0 +1,135 @@
+
+
+
+
Oracle Database@Google Cloud API . projects . locations . giVersions . minorVersions

+
Instance Methods

+

+  close()

+
Close httplib2 connections.

+

+  list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

+
Lists all the valid minor versions for the given project, location, gi version and shape family.

+

+  list_next()

+
Retrieves the next page of results.

+
Method Details

+

+    close()
+  
Close httplib2 connections.

+

+
+

+    list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+  
Lists all the valid minor versions for the given project, location, gi version and shape family.
+
+Args:
+  parent: string, Required. The parent value for the MinorVersion resource with the format: projects/{project}/locations/{location}/giVersions/{gi_version} (required)
+  filter: string, Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family="{shapeFamily}" AND gcp_oracle_zone_id="{gcp_oracle_zone_id}"`.
+  pageSize: integer, Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.
+  pageToken: string, Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for `MinorVersion.List`.
+  "minorVersions": [ # The list of MinorVersions.
+    { # MinorVersion represents a minor version of a GI. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiMinorVersionSummary/
+      "gridImageId": "A String", # Optional. The ID of the Grid Image.
+      "name": "A String", # Identifier. The name of the MinorVersion resource with the format: projects/{project}/locations/{region}/giVersions/{gi_version}/minorVersions/{minor_version}
+      "version": "A String", # Optional. The valid Oracle grid infrastructure software version.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+}

+

+
+

+    list_next()
+  
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        

+

+
+
\ No newline at end of file
diff --git a/docs/dyn/oracledatabase_v1.projects.locations.html b/docs/dyn/oracledatabase_v1.projects.locations.html
index 9753ba7d186..30aef0e1538 100644
--- a/docs/dyn/oracledatabase_v1.projects.locations.html
+++ b/docs/dyn/oracledatabase_v1.projects.locations.html
@@ -139,6 +139,16 @@ 
Instance Methods

 

 
Returns the entitlements Resource.

 
+

+  exadbVmClusters()
+

+
Returns the exadbVmClusters Resource.

+
+

+  exascaleDbStorageVaults()
+

+
Returns the exascaleDbStorageVaults Resource.

+
 

   giVersions()
 

diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json
index b64eb0137de..1a7b928f3e7 100644
--- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json
+++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json
@@ -343,6 +343,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"failover": {
+"description": "Initiates a failover to target autonomous database from the associated primary database.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:failover",
+"httpMethod": "POST",
+"id": "oracledatabase.projects.locations.autonomousDatabases.failover",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the Autonomous Database in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:failover",
+"request": {
+"$ref": "FailoverAutonomousDatabaseRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "generateWallet": {
 "description": "Generates a wallet for an Autonomous Database.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:generateWallet",
@@ -1427,83 +1455,38 @@
 }
 }
 },
-"giVersions": {
-"methods": {
-"list": {
-"description": "Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions",
-"httpMethod": "GET",
-"id": "oracledatabase.projects.locations.giVersions.list",
-"parameterOrder": [
-"parent"
-],
-"parameters": {
-"filter": {
-"description": "Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape=\"{shape}\"`.",
-"location": "query",
-"type": "string"
-},
-"pageSize": {
-"description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.",
-"format": "int32",
-"location": "query",
-"type": "integer"
-},
-"pageToken": {
-"description": "Optional. A token identifying a page of results the server should return.",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1/{+parent}/giVersions",
-"response": {
-"$ref": "ListGiVersionsResponse"
-},
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
-}
-}
-},
-"odbNetworks": {
+"exadbVmClusters": {
 "methods": {
 "create": {
-"description": "Creates a new ODB Network in a given project and location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks",
+"description": "Creates a new Exadb (Exascale) VM Cluster resource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters",
 "httpMethod": "POST",
-"id": "oracledatabase.projects.locations.odbNetworks.create",
+"id": "oracledatabase.projects.locations.exadbVmClusters.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"odbNetworkId": {
-"description": "Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.",
+"exadbVmClusterId": {
+"description": "Required. The ID of the ExadbVmCluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.",
+"description": "Required. The value for parent of the ExadbVmCluster in the following format: projects/{project}/locations/{location}.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 },
 "requestId": {
-"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
+"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/odbNetworks",
+"path": "v1/{+parent}/exadbVmClusters",
 "request": {
-"$ref": "OdbNetwork"
+"$ref": "ExadbVmCluster"
 },
 "response": {
 "$ref": "Operation"
@@ -1513,18 +1496,18 @@
 ]
 },
 "delete": {
-"description": "Deletes a single ODB Network.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}",
+"description": "Deletes a single Exadb (Exascale) VM Cluster.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}",
 "httpMethod": "DELETE",
-"id": "oracledatabase.projects.locations.odbNetworks.delete",
+"id": "oracledatabase.projects.locations.exadbVmClusters.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.",
+"description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -1543,35 +1526,35 @@
 ]
 },
 "get": {
-"description": "Gets details of a single ODB Network.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}",
+"description": "Gets details of a single Exadb (Exascale) VM Cluster.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}",
 "httpMethod": "GET",
-"id": "oracledatabase.projects.locations.odbNetworks.get",
+"id": "oracledatabase.projects.locations.exadbVmClusters.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.",
+"description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "OdbNetwork"
+"$ref": "ExadbVmCluster"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists the ODB Networks in a given project and location.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks",
+"description": "Lists all the Exadb (Exascale) VM Clusters for the given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters",
 "httpMethod": "GET",
-"id": "oracledatabase.projects.locations.odbNetworks.list",
+"id": "oracledatabase.projects.locations.exadbVmClusters.list",
 "parameterOrder": [
 "parent"
 ],
@@ -1587,7 +1570,7 @@
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+"description": "Optional. The maximum number of items to return. If unspecified, at most 50 ExadbVmClusters will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
@@ -1598,55 +1581,122 @@
 "type": "string"
 },
 "parent": {
-"description": "Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.",
+"description": "Required. The parent value for ExadbVmClusters in the following format: projects/{project}/locations/{location}.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/odbNetworks",
+"path": "v1/{+parent}/exadbVmClusters",
 "response": {
-"$ref": "ListOdbNetworksResponse"
+"$ref": "ListExadbVmClustersResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"patch": {
+"description": "Updates a single Exadb (Exascale) VM Cluster. To add virtual machines to existing exadb vm cluster, only pass the node count.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}",
+"httpMethod": "PATCH",
+"id": "oracledatabase.projects.locations.exadbVmClusters.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
+"location": "query",
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. A mask specifying which fields in th VM Cluster should be updated. A field specified in the mask is overwritten. If a mask isn't provided then all the fields in the VM Cluster are overwritten.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
 },
-"resources": {
-"odbSubnets": {
+"path": "v1/{+name}",
+"request": {
+"$ref": "ExadbVmCluster"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"removeVirtualMachine": {
+"description": "Removes virtual machines from an existing exadb vm cluster.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exadbVmClusters/{exadbVmClustersId}:removeVirtualMachine",
+"httpMethod": "POST",
+"id": "oracledatabase.projects.locations.exadbVmClusters.removeVirtualMachine",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the ExadbVmCluster in the following format: projects/{project}/locations/{location}/exadbVmClusters/{exadb_vm_cluster}.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/exadbVmClusters/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:removeVirtualMachine",
+"request": {
+"$ref": "RemoveVirtualMachineExadbVmClusterRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"exascaleDbStorageVaults": {
 "methods": {
 "create": {
-"description": "Creates a new ODB Subnet in a given ODB Network.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets",
+"description": "Creates a new ExascaleDB Storage Vault resource.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults",
 "httpMethod": "POST",
-"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.create",
+"id": "oracledatabase.projects.locations.exascaleDbStorageVaults.create",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
-"odbSubnetId": {
-"description": "Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.",
+"exascaleDbStorageVaultId": {
+"description": "Required. The ID of the ExascaleDbStorageVault to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.",
+"description": "Required. The value for parent of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 },
 "requestId": {
-"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
+"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+parent}/odbSubnets",
+"path": "v1/{+parent}/exascaleDbStorageVaults",
 "request": {
-"$ref": "OdbSubnet"
+"$ref": "ExascaleDbStorageVault"
 },
 "response": {
 "$ref": "Operation"
@@ -1656,18 +1706,18 @@
 ]
 },
 "delete": {
-"description": "Deletes a single ODB Subnet.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}",
+"description": "Deletes a single ExascaleDB Storage Vault.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults/{exascaleDbStorageVaultsId}",
 "httpMethod": "DELETE",
-"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.delete",
+"id": "oracledatabase.projects.locations.exascaleDbStorageVaults.delete",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.",
+"description": "Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exascaleDbStorageVaults/[^/]+$",
 "required": true,
 "type": "string"
 },
@@ -1686,51 +1736,51 @@
 ]
 },
 "get": {
-"description": "Gets details of a single ODB Subnet.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}",
+"description": "Gets details of a single ExascaleDB Storage Vault.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults/{exascaleDbStorageVaultsId}",
 "httpMethod": "GET",
-"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.get",
+"id": "oracledatabase.projects.locations.exascaleDbStorageVaults.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.",
+"description": "Required. The name of the ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/exascaleDbStorageVaults/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "OdbSubnet"
+"$ref": "ExascaleDbStorageVault"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists all the ODB Subnets in a given ODB Network.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets",
+"description": "Lists all the ExascaleDB Storage Vaults for the given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/exascaleDbStorageVaults",
 "httpMethod": "GET",
-"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.list",
+"id": "oracledatabase.projects.locations.exascaleDbStorageVaults.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. An expression for filtering the results of the request.",
+"description": "Optional. An expression for filtering the results of the request. Filter the list as specified in https://google.aip.dev/160.",
 "location": "query",
 "type": "string"
 },
 "orderBy": {
-"description": "Optional. An expression for ordering the results of the request.",
+"description": "Optional. An expression for ordering the results of the request. Order results as specified in https://google.aip.dev/132.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+"description": "Optional. The maximum number of items to return. If unspecified, at most 50 ExascaleDbStorageVaults will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
@@ -1741,292 +1791,670 @@
 "type": "string"
 },
 "parent": {
-"description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.",
+"description": "Required. The parent value for ExascaleDbStorageVault in the following format: projects/{project}/locations/{location}.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/odbSubnets",
+"path": "v1/{+parent}/exascaleDbStorageVaults",
 "response": {
-"$ref": "ListOdbSubnetsResponse"
+"$ref": "ListExascaleDbStorageVaultsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
 }
-}
-}
 },
-"operations": {
+"giVersions": {
 "methods": {
-"cancel": {
-"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
-"httpMethod": "POST",
-"id": "oracledatabase.projects.locations.operations.cancel",
+"list": {
+"description": "Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions",
+"httpMethod": "GET",
+"id": "oracledatabase.projects.locations.giVersions.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource to be cancelled.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
-"required": true,
+"filter": {
+"description": "Optional. An expression for filtering the results of the request. Only the shape, gcp_oracle_zone and gi_version fields are supported in this format: `shape=\"{shape}\"`.",
+"location": "query",
 "type": "string"
-}
-},
-"path": "v1/{+name}:cancel",
-"request": {
-"$ref": "CancelOperationRequest"
 },
-"response": {
-"$ref": "Empty"
+"pageSize": {
+"description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
 },
-"scopes": [
-"https://www.googleapis.com/auth/cloud-platform"
-]
+"pageToken": {
+"description": "Optional. A token identifying a page of results the server should return.",
+"location": "query",
+"type": "string"
 },
-"delete": {
-"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
-"httpMethod": "DELETE",
-"id": "oracledatabase.projects.locations.operations.delete",
-"parameterOrder": [
-"name"
-],
-"parameters": {
-"name": {
-"description": "The name of the operation resource to be deleted.",
+"parent": {
+"description": "Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+parent}/giVersions",
 "response": {
-"$ref": "Empty"
+"$ref": "ListGiVersionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
 },
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"resources": {
+"minorVersions": {
+"methods": {
+"list": {
+"description": "Lists all the valid minor versions for the given project, location, gi version and shape family.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions/{giVersionsId}/minorVersions",
 "httpMethod": "GET",
-"id": "oracledatabase.projects.locations.operations.get",
+"id": "oracledatabase.projects.locations.giVersions.minorVersions.list",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"filter": {
+"description": "Optional. An expression for filtering the results of the request. Only shapeFamily and gcp_oracle_zone_id are supported in this format: `shape_family=\"{shapeFamily}\" AND gcp_oracle_zone_id=\"{gcp_oracle_zone_id}\"`.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent value for the MinorVersion resource with the format: projects/{project}/locations/{location}/giVersions/{gi_version}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/giVersions/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+name}",
+"path": "v1/{+parent}/minorVersions",
 "response": {
-"$ref": "Operation"
+"$ref": "ListMinorVersionsResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
+}
+}
 },
-"list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
-"httpMethod": "GET",
-"id": "oracledatabase.projects.locations.operations.list",
+"odbNetworks": {
+"methods": {
+"create": {
+"description": "Creates a new ODB Network in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks",
+"httpMethod": "POST",
+"id": "oracledatabase.projects.locations.odbNetworks.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
+"odbNetworkId": {
+"description": "Required. The ID of the OdbNetwork to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.",
 "location": "query",
 "type": "string"
 },
-"name": {
-"description": "The name of the operation's parent resource.",
+"parent": {
+"description": "Required. The parent value for the OdbNetwork in the following format: projects/{project}/locations/{location}.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 },
-"pageSize": {
-"description": "The standard list page size.",
-"format": "int32",
+"requestId": {
+"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
 "location": "query",
-"type": "integer"
+"type": "string"
+}
 },
-"pageToken": {
-"description": "The standard list page token.",
+"path": "v1/{+parent}/odbNetworks",
+"request": {
+"$ref": "OdbNetwork"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a single ODB Network.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}",
+"httpMethod": "DELETE",
+"id": "oracledatabase.projects.locations.odbNetworks.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$",
+"required": true,
+"type": "string"
+},
+"requestId": {
+"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
 "location": "query",
 "type": "string"
 }
 },
-"path": "v1/{+name}/operations",
+"path": "v1/{+name}",
 "response": {
-"$ref": "ListOperationsResponse"
+"$ref": "Operation"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
 },
-"pluggableDatabases": {
-"methods": {
 "get": {
-"description": "Gets details of a single PluggableDatabase.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases/{pluggableDatabasesId}",
+"description": "Gets details of a single ODB Network.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}",
 "httpMethod": "GET",
-"id": "oracledatabase.projects.locations.pluggableDatabases.get",
+"id": "oracledatabase.projects.locations.odbNetworks.get",
 "parameterOrder": [
 "name"
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}",
+"description": "Required. The name of the OdbNetwork in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/pluggableDatabases/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
 "path": "v1/{+name}",
 "response": {
-"$ref": "PluggableDatabase"
+"$ref": "OdbNetwork"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
 "list": {
-"description": "Lists all the PluggableDatabases for the given project, location and Container Database.",
-"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases",
+"description": "Lists the ODB Networks in a given project and location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks",
 "httpMethod": "GET",
-"id": "oracledatabase.projects.locations.pluggableDatabases.list",
+"id": "oracledatabase.projects.locations.odbNetworks.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
 "filter": {
-"description": "Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: `database=\"projects/{project}/locations/{location}/databases/{database}\"`",
+"description": "Optional. An expression for filtering the results of the request.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. An expression for ordering the results of the request.",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.",
+"description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "Optional. A page token, received from a previous `ListPluggableDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluggableDatabases` must match the call that provided the page token.",
+"description": "Optional. A token identifying a page of results the server should return.",
 "location": "query",
 "type": "string"
 },
 "parent": {
-"description": "Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}",
+"description": "Required. The parent value for the ODB Network in the following format: projects/{project}/locations/{location}.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
 }
 },
-"path": "v1/{+parent}/pluggableDatabases",
+"path": "v1/{+parent}/odbNetworks",
 "response": {
-"$ref": "ListPluggableDatabasesResponse"
+"$ref": "ListOdbNetworksResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
-}
-}
-}
-}
-}
-}
 },
-"revision": "20250914",
-"rootUrl": "https://oracledatabase.googleapis.com/",
-"schemas": {
-"AllConnectionStrings": {
-"description": "A list of all connection strings that can be used to connect to the Autonomous Database.",
-"id": "AllConnectionStrings",
-"properties": {
-"high": {
-"description": "Output only. The database service provides the highest level of resources to each SQL statement.",
-"readOnly": true,
+"resources": {
+"odbSubnets": {
+"methods": {
+"create": {
+"description": "Creates a new ODB Subnet in a given ODB Network.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets",
+"httpMethod": "POST",
+"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"odbSubnetId": {
+"description": "Required. The ID of the OdbSubnet to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.",
+"location": "query",
 "type": "string"
 },
-"low": {
-"description": "Output only. The database service provides the least level of resources to each SQL statement.",
-"readOnly": true,
+"parent": {
+"description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$",
+"required": true,
 "type": "string"
 },
-"medium": {
-"description": "Output only. The database service provides a lower level of resources to each SQL statement.",
-"readOnly": true,
+"requestId": {
+"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
+"location": "query",
 "type": "string"
 }
 },
-"type": "object"
-},
-"AutonomousDatabase": {
-"description": "Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/",
-"id": "AutonomousDatabase",
-"properties": {
-"adminPassword": {
-"description": "Optional. The password for the default ADMIN user.",
-"type": "string"
+"path": "v1/{+parent}/odbSubnets",
+"request": {
+"$ref": "OdbSubnet"
 },
-"cidr": {
-"description": "Optional. The subnet CIDR range for the Autonomous Database.",
-"type": "string"
+"response": {
+"$ref": "Operation"
 },
-"createTime": {
-"description": "Output only. The date and time that the Autonomous Database was created.",
-"format": "google-datetime",
-"readOnly": true,
-"type": "string"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
-"database": {
-"description": "Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.",
+"delete": {
+"description": "Deletes a single ODB Subnet.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}",
+"httpMethod": "DELETE",
+"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the resource in the following format: projects/{project}/locations/{region}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$",
+"required": true,
 "type": "string"
 },
-"disasterRecoverySupportedLocations": {
-"description": "Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.",
-"items": {
+"requestId": {
+"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
+"location": "query",
 "type": "string"
+}
 },
-"readOnly": true,
-"type": "array"
+"path": "v1/{+name}",
+"response": {
+"$ref": "Operation"
 },
-"displayName": {
-"description": "Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.",
-"type": "string"
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
-"entitlementId": {
-"description": "Output only. The ID of the subscription entitlement associated with the Autonomous Database.",
-"readOnly": true,
+"get": {
+"description": "Gets details of a single ODB Subnet.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets/{odbSubnetsId}",
+"httpMethod": "GET",
+"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbSubnets/[^/]+$",
+"required": true,
 "type": "string"
+}
 },
-"labels": {
-"additionalProperties": {
-"type": "string"
+"path": "v1/{+name}",
+"response": {
+"$ref": "OdbSubnet"
 },
-"description": "Optional. The labels or tags associated with the Autonomous Database.",
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists all the ODB Subnets in a given ODB Network.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbSubnets",
+"httpMethod": "GET",
+"id": "oracledatabase.projects.locations.odbNetworks.odbSubnets.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. An expression for filtering the results of the request.",
+"location": "query",
+"type": "string"
+},
+"orderBy": {
+"description": "Optional. An expression for ordering the results of the request.",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of items to return. If unspecified, at most 50 ODB Networks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A token identifying a page of results the server should return.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent value for the OdbSubnet in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/odbSubnets",
+"response": {
+"$ref": "ListOdbSubnetsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"operations": {
+"methods": {
+"cancel": {
+"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
+"httpMethod": "POST",
+"id": "oracledatabase.projects.locations.operations.cancel",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be cancelled.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:cancel",
+"request": {
+"$ref": "CancelOperationRequest"
+},
+"response": {
+"$ref": "Empty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"delete": {
+"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"httpMethod": "DELETE",
+"id": "oracledatabase.projects.locations.operations.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource to be deleted.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Empty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "oracledatabase.projects.locations.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
+"httpMethod": "GET",
+"id": "oracledatabase.projects.locations.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1/{+name}/operations",
+"response": {
+"$ref": "ListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
+"pluggableDatabases": {
+"methods": {
+"get": {
+"description": "Gets details of a single PluggableDatabase.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases/{pluggableDatabasesId}",
+"httpMethod": "GET",
+"id": "oracledatabase.projects.locations.pluggableDatabases.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the PluggableDatabase resource in the following format: projects/{project}/locations/{region}/pluggableDatabases/{pluggable_database}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/pluggableDatabases/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "PluggableDatabase"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists all the PluggableDatabases for the given project, location and Container Database.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pluggableDatabases",
+"httpMethod": "GET",
+"id": "oracledatabase.projects.locations.pluggableDatabases.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter": {
+"description": "Optional. An expression for filtering the results of the request. List for pluggable databases is supported only with a valid container database (full resource name) filter in this format: `database=\"projects/{project}/locations/{location}/databases/{database}\"`",
+"location": "query",
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of PluggableDatabases to return. The service may return fewer than this value.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous `ListPluggableDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPluggableDatabases` must match the call that provided the page token.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent, which owns this collection of PluggableDatabases. Format: projects/{project}/locations/{location}",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/pluggableDatabases",
+"response": {
+"$ref": "ListPluggableDatabasesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+}
+}
+}
+},
+"revision": "20250918",
+"rootUrl": "https://oracledatabase.googleapis.com/",
+"schemas": {
+"AllConnectionStrings": {
+"description": "A list of all connection strings that can be used to connect to the Autonomous Database.",
+"id": "AllConnectionStrings",
+"properties": {
+"high": {
+"description": "Output only. The database service provides the highest level of resources to each SQL statement.",
+"readOnly": true,
+"type": "string"
+},
+"low": {
+"description": "Output only. The database service provides the least level of resources to each SQL statement.",
+"readOnly": true,
+"type": "string"
+},
+"medium": {
+"description": "Output only. The database service provides a lower level of resources to each SQL statement.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"AutonomousDatabase": {
+"description": "Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/",
+"id": "AutonomousDatabase",
+"properties": {
+"adminPassword": {
+"description": "Optional. The password for the default ADMIN user.",
+"type": "string"
+},
+"cidr": {
+"description": "Optional. The subnet CIDR range for the Autonomous Database.",
+"type": "string"
+},
+"createTime": {
+"description": "Output only. The date and time that the Autonomous Database was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"database": {
+"description": "Optional. The name of the Autonomous Database. The database name must be unique in the project. The name must begin with a letter and can contain a maximum of 30 alphanumeric characters.",
+"type": "string"
+},
+"disasterRecoverySupportedLocations": {
+"description": "Output only. List of supported GCP region to clone the Autonomous Database for disaster recovery. Format: `project/{project}/locations/{location}`.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"displayName": {
+"description": "Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.",
+"type": "string"
+},
+"entitlementId": {
+"description": "Output only. The ID of the subscription entitlement associated with the Autonomous Database.",
+"readOnly": true,
+"type": "string"
+},
+"labels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. The labels or tags associated with the Autonomous Database.",
 "type": "object"
 },
 "name": {
@@ -3108,49 +3536,305 @@
 "additionalProperties": {
 "type": "string"
 },
-"description": "Optional. Labels or tags associated with the resource.",
+"description": "Optional. Labels or tags associated with the resource.",
+"type": "object"
+},
+"name": {
+"description": "Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}",
+"type": "string"
+},
+"properties": {
+"$ref": "CloudExadataInfrastructureProperties",
+"description": "Optional. Various properties of the infra."
+}
+},
+"type": "object"
+},
+"CloudExadataInfrastructureProperties": {
+"description": "Various properties of Exadata Infrastructure.",
+"id": "CloudExadataInfrastructureProperties",
+"properties": {
+"activatedStorageCount": {
+"description": "Output only. The requested number of additional storage servers activated for the Exadata Infrastructure.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"additionalStorageCount": {
+"description": "Output only. The requested number of additional storage servers for the Exadata Infrastructure.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"availableStorageSizeGb": {
+"description": "Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB).",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"computeCount": {
+"description": "Optional. The number of compute servers for the Exadata Infrastructure.",
+"format": "int32",
+"type": "integer"
+},
+"computeModel": {
+"description": "Output only. The compute model of the Exadata Infrastructure.",
+"enum": [
+"COMPUTE_MODEL_UNSPECIFIED",
+"COMPUTE_MODEL_ECPU",
+"COMPUTE_MODEL_OCPU"
+],
+"enumDescriptions": [
+"Unspecified compute model.",
+"Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.",
+"Physical measure of compute resources. OCPUs are based on the physical core of a processor."
+],
+"readOnly": true,
+"type": "string"
+},
+"cpuCount": {
+"description": "Output only. The number of enabled CPU cores.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"customerContacts": {
+"description": "Optional. The list of customer contacts.",
+"items": {
+"$ref": "CustomerContact"
+},
+"type": "array"
+},
+"dataStorageSizeTb": {
+"description": "Output only. Size, in terabytes, of the DATA disk group.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+},
+"databaseServerType": {
+"description": "Output only. The database server type of the Exadata Infrastructure.",
+"readOnly": true,
+"type": "string"
+},
+"dbNodeStorageSizeGb": {
+"description": "Output only. The local node storage allocated in GBs.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"dbServerVersion": {
+"description": "Output only. The software version of the database servers (dom0) in the Exadata Infrastructure.",
+"readOnly": true,
+"type": "string"
+},
+"maintenanceWindow": {
+"$ref": "MaintenanceWindow",
+"description": "Optional. Maintenance window for repair."
+},
+"maxCpuCount": {
+"description": "Output only. The total number of CPU cores available.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"maxDataStorageTb": {
+"description": "Output only. The total available DATA disk group size.",
+"format": "double",
+"readOnly": true,
+"type": "number"
+},
+"maxDbNodeStorageSizeGb": {
+"description": "Output only. The total local node storage available in GBs.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"maxMemoryGb": {
+"description": "Output only. The total memory available in GBs.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"memorySizeGb": {
+"description": "Output only. The memory allocated in GBs.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"monthlyDbServerVersion": {
+"description": "Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15",
+"readOnly": true,
+"type": "string"
+},
+"monthlyStorageServerVersion": {
+"description": "Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15",
+"readOnly": true,
+"type": "string"
+},
+"nextMaintenanceRunId": {
+"description": "Output only. The OCID of the next maintenance run.",
+"readOnly": true,
+"type": "string"
+},
+"nextMaintenanceRunTime": {
+"description": "Output only. The time when the next maintenance run will occur.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"nextSecurityMaintenanceRunTime": {
+"description": "Output only. The time when the next security maintenance run will occur.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"ociUrl": {
+"description": "Output only. Deep link to the OCI console to view this resource.",
+"readOnly": true,
+"type": "string"
+},
+"ocid": {
+"description": "Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle",
+"readOnly": true,
+"type": "string"
+},
+"shape": {
+"description": "Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.",
+"type": "string"
+},
+"state": {
+"description": "Output only. The current lifecycle state of the Exadata Infrastructure.",
+"enum": [
+"STATE_UNSPECIFIED",
+"PROVISIONING",
+"AVAILABLE",
+"UPDATING",
+"TERMINATING",
+"TERMINATED",
+"FAILED",
+"MAINTENANCE_IN_PROGRESS"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"The Exadata Infrastructure is being provisioned.",
+"The Exadata Infrastructure is available for use.",
+"The Exadata Infrastructure is being updated.",
+"The Exadata Infrastructure is being terminated.",
+"The Exadata Infrastructure is terminated.",
+"The Exadata Infrastructure is in failed state.",
+"The Exadata Infrastructure is in maintenance."
+],
+"readOnly": true,
+"type": "string"
+},
+"storageCount": {
+"description": "Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure.",
+"format": "int32",
+"type": "integer"
+},
+"storageServerType": {
+"description": "Output only. The storage server type of the Exadata Infrastructure.",
+"readOnly": true,
+"type": "string"
+},
+"storageServerVersion": {
+"description": "Output only. The software version of the storage servers (cells) in the Exadata Infrastructure.",
+"readOnly": true,
+"type": "string"
+},
+"totalStorageSizeGb": {
+"description": "Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB).",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"CloudVmCluster": {
+"description": "Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/",
+"id": "CloudVmCluster",
+"properties": {
+"backupOdbSubnet": {
+"description": "Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}",
+"type": "string"
+},
+"backupSubnetCidr": {
+"description": "Optional. CIDR range of the backup subnet.",
+"type": "string"
+},
+"cidr": {
+"description": "Optional. Network settings. CIDR to use for cluster IP allocation.",
+"type": "string"
+},
+"createTime": {
+"description": "Output only. The date and time that the VM cluster was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"displayName": {
+"description": "Optional. User friendly name for this resource.",
+"type": "string"
+},
+"exadataInfrastructure": {
+"description": "Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}",
+"type": "string"
+},
+"gcpOracleZone": {
+"description": "Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.",
+"readOnly": true,
+"type": "string"
+},
+"identityConnector": {
+"$ref": "IdentityConnector",
+"description": "Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.",
+"readOnly": true
+},
+"labels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. Labels or tags associated with the VM Cluster.",
 "type": "object"
 },
 "name": {
-"description": "Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}",
+"description": "Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}",
+"type": "string"
+},
+"network": {
+"description": "Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}",
+"type": "string"
+},
+"odbNetwork": {
+"description": "Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.",
+"type": "string"
+},
+"odbSubnet": {
+"description": "Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}",
 "type": "string"
 },
 "properties": {
-"$ref": "CloudExadataInfrastructureProperties",
-"description": "Optional. Various properties of the infra."
+"$ref": "CloudVmClusterProperties",
+"description": "Optional. Various properties of the VM Cluster."
 }
 },
 "type": "object"
 },
-"CloudExadataInfrastructureProperties": {
-"description": "Various properties of Exadata Infrastructure.",
-"id": "CloudExadataInfrastructureProperties",
+"CloudVmClusterProperties": {
+"description": "Various properties and settings associated with Exadata VM cluster.",
+"id": "CloudVmClusterProperties",
 "properties": {
-"activatedStorageCount": {
-"description": "Output only. The requested number of additional storage servers activated for the Exadata Infrastructure.",
-"format": "int32",
-"readOnly": true,
-"type": "integer"
-},
-"additionalStorageCount": {
-"description": "Output only. The requested number of additional storage servers for the Exadata Infrastructure.",
-"format": "int32",
-"readOnly": true,
-"type": "integer"
+"clusterName": {
+"description": "Optional. OCI Cluster name.",
+"type": "string"
 },
-"availableStorageSizeGb": {
-"description": "Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB).",
-"format": "int32",
+"compartmentId": {
+"description": "Output only. Compartment ID of cluster.",
 "readOnly": true,
-"type": "integer"
-},
-"computeCount": {
-"description": "Optional. The number of compute servers for the Exadata Infrastructure.",
-"format": "int32",
-"type": "integer"
+"type": "string"
 },
 "computeModel": {
-"description": "Output only. The compute model of the Exadata Infrastructure.",
+"description": "Output only. The compute model of the VM Cluster.",
 "enum": [
 "COMPUTE_MODEL_UNSPECIFIED",
 "COMPUTE_MODEL_ECPU",
@@ -3164,118 +3848,160 @@
 "readOnly": true,
 "type": "string"
 },
-"cpuCount": {
-"description": "Output only. The number of enabled CPU cores.",
+"cpuCoreCount": {
+"description": "Required. Number of enabled CPU cores.",
 "format": "int32",
-"readOnly": true,
 "type": "integer"
 },
-"customerContacts": {
-"description": "Optional. The list of customer contacts.",
-"items": {
-"$ref": "CustomerContact"
-},
-"type": "array"
-},
 "dataStorageSizeTb": {
-"description": "Output only. Size, in terabytes, of the DATA disk group.",
+"description": "Optional. The data disk group size to be allocated in TBs.",
 "format": "double",
-"readOnly": true,
 "type": "number"
 },
-"databaseServerType": {
-"description": "Output only. The database server type of the Exadata Infrastructure.",
-"readOnly": true,
-"type": "string"
-},
 "dbNodeStorageSizeGb": {
-"description": "Output only. The local node storage allocated in GBs.",
+"description": "Optional. Local storage per VM.",
 "format": "int32",
-"readOnly": true,
 "type": "integer"
 },
-"dbServerVersion": {
-"description": "Output only. The software version of the database servers (dom0) in the Exadata Infrastructure.",
-"readOnly": true,
+"dbServerOcids": {
+"description": "Optional. OCID of database servers.",
+"items": {
 "type": "string"
 },
-"maintenanceWindow": {
-"$ref": "MaintenanceWindow",
-"description": "Optional. Maintenance window for repair."
+"type": "array"
 },
-"maxCpuCount": {
-"description": "Output only. The total number of CPU cores available.",
-"format": "int32",
+"diagnosticsDataCollectionOptions": {
+"$ref": "DataCollectionOptions",
+"description": "Optional. Data collection options for diagnostics."
+},
+"diskRedundancy": {
+"description": "Optional. The type of redundancy.",
+"enum": [
+"DISK_REDUNDANCY_UNSPECIFIED",
+"HIGH",
+"NORMAL"
+],
+"enumDescriptions": [
+"Unspecified.",
+"High - 3 way mirror.",
+"Normal - 2 way mirror."
+],
+"type": "string"
+},
+"dnsListenerIp": {
+"description": "Output only. DNS listener IP.",
 "readOnly": true,
-"type": "integer"
+"type": "string"
 },
-"maxDataStorageTb": {
-"description": "Output only. The total available DATA disk group size.",
-"format": "double",
+"domain": {
+"description": "Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com",
 "readOnly": true,
-"type": "number"
+"type": "string"
 },
-"maxDbNodeStorageSizeGb": {
-"description": "Output only. The total local node storage available in GBs.",
-"format": "int32",
+"giVersion": {
+"description": "Optional. Grid Infrastructure Version.",
+"type": "string"
+},
+"hostname": {
+"description": "Output only. host name without domain. format: \"-\" with some suffix. ex: sp2-yi0xq where \"sp2\" is the hostname_prefix.",
 "readOnly": true,
-"type": "integer"
+"type": "string"
 },
-"maxMemoryGb": {
-"description": "Output only. The total memory available in GBs.",
+"hostnamePrefix": {
+"description": "Optional. Prefix for VM cluster host names.",
+"type": "string"
+},
+"licenseType": {
+"description": "Required. License type of VM Cluster.",
+"enum": [
+"LICENSE_TYPE_UNSPECIFIED",
+"LICENSE_INCLUDED",
+"BRING_YOUR_OWN_LICENSE"
+],
+"enumDescriptions": [
+"Unspecified",
+"License included part of offer",
+"Bring your own license"
+],
+"type": "string"
+},
+"localBackupEnabled": {
+"description": "Optional. Use local backup.",
+"type": "boolean"
+},
+"memorySizeGb": {
+"description": "Optional. Memory allocated in GBs.",
 "format": "int32",
-"readOnly": true,
 "type": "integer"
 },
-"memorySizeGb": {
-"description": "Output only. The memory allocated in GBs.",
+"nodeCount": {
+"description": "Optional. Number of database servers.",
 "format": "int32",
-"readOnly": true,
 "type": "integer"
 },
-"monthlyDbServerVersion": {
-"description": "Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15",
+"ociUrl": {
+"description": "Output only. Deep link to the OCI console to view this resource.",
 "readOnly": true,
 "type": "string"
 },
-"monthlyStorageServerVersion": {
-"description": "Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15",
+"ocid": {
+"description": "Output only. Oracle Cloud Infrastructure ID of VM Cluster.",
 "readOnly": true,
 "type": "string"
 },
-"nextMaintenanceRunId": {
-"description": "Output only. The OCID of the next maintenance run.",
+"ocpuCount": {
+"description": "Optional. OCPU count per VM. Minimum is 0.1.",
+"format": "float",
+"type": "number"
+},
+"scanDns": {
+"description": "Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com",
 "readOnly": true,
 "type": "string"
 },
-"nextMaintenanceRunTime": {
-"description": "Output only. The time when the next maintenance run will occur.",
-"format": "google-datetime",
+"scanDnsRecordId": {
+"description": "Output only. OCID of scan DNS record.",
 "readOnly": true,
 "type": "string"
 },
-"nextSecurityMaintenanceRunTime": {
-"description": "Output only. The time when the next security maintenance run will occur.",
-"format": "google-datetime",
-"readOnly": true,
+"scanIpIds": {
+"description": "Output only. OCIDs of scan IPs.",
+"items": {
 "type": "string"
 },
-"ociUrl": {
-"description": "Output only. Deep link to the OCI console to view this resource.",
 "readOnly": true,
-"type": "string"
+"type": "array"
 },
-"ocid": {
-"description": "Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle",
+"scanListenerPortTcp": {
+"description": "Output only. SCAN listener port - TCP",
+"format": "int32",
 "readOnly": true,
-"type": "string"
+"type": "integer"
+},
+"scanListenerPortTcpSsl": {
+"description": "Output only. SCAN listener port - TLS",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
 },
 "shape": {
-"description": "Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.",
+"description": "Output only. Shape of VM Cluster.",
+"readOnly": true,
+"type": "string"
+},
+"sparseDiskgroupEnabled": {
+"description": "Optional. Use exadata sparse snapshots.",
+"type": "boolean"
+},
+"sshPublicKeys": {
+"description": "Optional. SSH public keys to be stored with cluster.",
+"items": {
 "type": "string"
 },
+"type": "array"
+},
 "state": {
-"description": "Output only. The current lifecycle state of the Exadata Infrastructure.",
+"description": "Output only. State of the cluster.",
 "enum": [
 "STATE_UNSPECIFIED",
 "PROVISIONING",
@@ -3288,1296 +4014,1374 @@
 ],
 "enumDescriptions": [
 "Default unspecified value.",
-"The Exadata Infrastructure is being provisioned.",
-"The Exadata Infrastructure is available for use.",
-"The Exadata Infrastructure is being updated.",
-"The Exadata Infrastructure is being terminated.",
-"The Exadata Infrastructure is terminated.",
-"The Exadata Infrastructure is in failed state.",
-"The Exadata Infrastructure is in maintenance."
+"Indicates that the resource is in provisioning state.",
+"Indicates that the resource is in available state.",
+"Indicates that the resource is in updating state.",
+"Indicates that the resource is in terminating state.",
+"Indicates that the resource is in terminated state.",
+"Indicates that the resource is in failed state.",
+"Indicates that the resource is in maintenance in progress state."
 ],
 "readOnly": true,
 "type": "string"
 },
-"storageCount": {
-"description": "Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure.",
-"format": "int32",
-"type": "integer"
-},
-"storageServerType": {
-"description": "Output only. The storage server type of the Exadata Infrastructure.",
-"readOnly": true,
-"type": "string"
-},
-"storageServerVersion": {
-"description": "Output only. The software version of the storage servers (cells) in the Exadata Infrastructure.",
-"readOnly": true,
-"type": "string"
-},
-"totalStorageSizeGb": {
-"description": "Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB).",
+"storageSizeGb": {
+"description": "Output only. The storage allocation for the disk group, in gigabytes (GB).",
 "format": "int32",
+"readOnly": true,
 "type": "integer"
+},
+"systemVersion": {
+"description": "Optional. Operating system version of the image.",
+"type": "string"
+},
+"timeZone": {
+"$ref": "TimeZone",
+"description": "Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified."
 }
 },
 "type": "object"
 },
-"CloudVmCluster": {
-"description": "Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/",
-"id": "CloudVmCluster",
+"CustomerContact": {
+"description": "The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact",
+"id": "CustomerContact",
 "properties": {
-"backupOdbSubnet": {
-"description": "Optional. The name of the backup OdbSubnet associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}",
+"email": {
+"description": "Required. The email address used by Oracle to send notifications regarding databases and infrastructure.",
 "type": "string"
+}
 },
-"backupSubnetCidr": {
-"description": "Optional. CIDR range of the backup subnet.",
+"type": "object"
+},
+"DataCollectionOptions": {
+"description": "Data collection options for diagnostics.",
+"id": "DataCollectionOptions",
+"properties": {
+"diagnosticsEventsEnabled": {
+"description": "Optional. Indicates whether diagnostic collection is enabled for the VM cluster",
+"type": "boolean"
+},
+"healthMonitoringEnabled": {
+"description": "Optional. Indicates whether health monitoring is enabled for the VM cluster",
+"type": "boolean"
+},
+"incidentLogsEnabled": {
+"description": "Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"DataCollectionOptionsCommon": {
+"description": "Data collection options for diagnostics. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DataCollectionOptions",
+"id": "DataCollectionOptionsCommon",
+"properties": {
+"isDiagnosticsEventsEnabled": {
+"description": "Optional. Indicates whether to enable data collection for diagnostics.",
+"type": "boolean"
+},
+"isHealthMonitoringEnabled": {
+"description": "Optional. Indicates whether to enable health monitoring.",
+"type": "boolean"
+},
+"isIncidentLogsEnabled": {
+"description": "Optional. Indicates whether to enable incident logs and trace collection.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"DataCollectionOptionsDbSystem": {
+"description": "Data collection options for DbSystem.",
+"id": "DataCollectionOptionsDbSystem",
+"properties": {
+"isDiagnosticsEventsEnabled": {
+"description": "Optional. Indicates whether to enable data collection for diagnostics.",
+"type": "boolean"
+},
+"isIncidentLogsEnabled": {
+"description": "Optional. Indicates whether to enable incident logs and trace collection.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"Database": {
+"description": "Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/",
+"id": "Database",
+"properties": {
+"adminPassword": {
+"description": "Required. The password for the default ADMIN user.",
 "type": "string"
 },
-"cidr": {
-"description": "Optional. Network settings. CIDR to use for cluster IP allocation.",
+"characterSet": {
+"description": "Optional. The character set for the database. The default is AL32UTF8.",
 "type": "string"
 },
 "createTime": {
-"description": "Output only. The date and time that the VM cluster was created.",
+"description": "Output only. The date and time that the Database was created.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
 },
-"displayName": {
-"description": "Optional. User friendly name for this resource.",
+"databaseId": {
+"description": "Optional. The database ID of the Database.",
 "type": "string"
 },
-"exadataInfrastructure": {
-"description": "Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}",
+"dbHomeName": {
+"description": "Optional. The name of the DbHome resource associated with the Database.",
 "type": "string"
 },
-"gcpOracleZone": {
-"description": "Output only. The GCP Oracle zone where Oracle CloudVmCluster is hosted. This will be the same as the gcp_oracle_zone of the CloudExadataInfrastructure. Example: us-east4-b-r2.",
-"readOnly": true,
+"dbName": {
+"description": "Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.",
 "type": "string"
 },
-"identityConnector": {
-"$ref": "IdentityConnector",
-"description": "Output only. The identity connector details which will allow OCI to securely access the resources in the customer project.",
-"readOnly": true
-},
-"labels": {
-"additionalProperties": {
+"dbUniqueName": {
+"description": "Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.",
 "type": "string"
 },
-"description": "Optional. Labels or tags associated with the VM Cluster.",
-"type": "object"
+"gcpOracleZone": {
+"description": "Output only. The GCP Oracle zone where the Database is created.",
+"readOnly": true,
+"type": "string"
 },
 "name": {
-"description": "Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}",
+"description": "Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}",
 "type": "string"
 },
-"network": {
-"description": "Optional. The name of the VPC network. Format: projects/{project}/global/networks/{network}",
+"ncharacterSet": {
+"description": "Optional. The national character set for the database. The default is AL16UTF16.",
 "type": "string"
 },
-"odbNetwork": {
-"description": "Optional. The name of the OdbNetwork associated with the VM Cluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the odb_subnet and backup_odb_subnet.",
+"ociUrl": {
+"description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.",
+"readOnly": true,
 "type": "string"
 },
-"odbSubnet": {
-"description": "Optional. The name of the OdbSubnet associated with the VM Cluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}",
+"opsInsightsStatus": {
+"description": "Output only. The Status of Operations Insights for this Database.",
+"enum": [
+"OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED",
+"ENABLING",
+"ENABLED",
+"DISABLING",
+"NOT_ENABLED",
+"FAILED_ENABLING",
+"FAILED_DISABLING"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"Indicates that the operations insights are being enabled.",
+"Indicates that the operations insights are enabled.",
+"Indicates that the operations insights are being disabled.",
+"Indicates that the operations insights are not enabled.",
+"Indicates that the operations insights failed to enable.",
+"Indicates that the operations insights failed to disable."
+],
+"readOnly": true,
 "type": "string"
 },
 "properties": {
-"$ref": "CloudVmClusterProperties",
-"description": "Optional. Various properties of the VM Cluster."
+"$ref": "DatabaseProperties",
+"description": "Optional. The properties of the Database."
+},
+"tdeWalletPassword": {
+"description": "Optional. The TDE wallet password for the database.",
+"type": "string"
 }
 },
 "type": "object"
 },
-"CloudVmClusterProperties": {
-"description": "Various properties and settings associated with Exadata VM cluster.",
-"id": "CloudVmClusterProperties",
+"DatabaseCharacterSet": {
+"description": "Details of the Database character set resource.",
+"id": "DatabaseCharacterSet",
 "properties": {
-"clusterName": {
-"description": "Optional. OCI Cluster name.",
-"type": "string"
-},
-"compartmentId": {
-"description": "Output only. Compartment ID of cluster.",
+"characterSet": {
+"description": "Output only. The character set name for the Database which is the ID in the resource name.",
 "readOnly": true,
 "type": "string"
 },
-"computeModel": {
-"description": "Output only. The compute model of the VM Cluster.",
+"characterSetType": {
+"description": "Output only. The character set type for the Database.",
 "enum": [
-"COMPUTE_MODEL_UNSPECIFIED",
-"COMPUTE_MODEL_ECPU",
-"COMPUTE_MODEL_OCPU"
+"CHARACTER_SET_TYPE_UNSPECIFIED",
+"DATABASE",
+"NATIONAL"
 ],
 "enumDescriptions": [
-"Unspecified compute model.",
-"Abstract measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers.",
-"Physical measure of compute resources. OCPUs are based on the physical core of a processor."
+"Character set type is not specified.",
+"Character set type is set to database.",
+"Character set type is set to national."
 ],
 "readOnly": true,
 "type": "string"
 },
-"cpuCoreCount": {
-"description": "Required. Number of enabled CPU cores.",
-"format": "int32",
-"type": "integer"
+"name": {
+"description": "Identifier. The name of the Database Character Set resource in the following format: projects/{project}/locations/{region}/databaseCharacterSets/{database_character_set}",
+"type": "string"
+}
 },
-"dataStorageSizeTb": {
-"description": "Optional. The data disk group size to be allocated in TBs.",
-"format": "double",
-"type": "number"
+"type": "object"
 },
-"dbNodeStorageSizeGb": {
-"description": "Optional. Local storage per VM.",
-"format": "int32",
-"type": "integer"
+"DatabaseConnectionStringProfile": {
+"description": "The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile",
+"id": "DatabaseConnectionStringProfile",
+"properties": {
+"consumerGroup": {
+"description": "Output only. The current consumer group being used by the connection.",
+"enum": [
+"CONSUMER_GROUP_UNSPECIFIED",
+"HIGH",
+"MEDIUM",
+"LOW",
+"TP",
+"TPURGENT"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"High consumer group.",
+"Medium consumer group.",
+"Low consumer group.",
+"TP consumer group.",
+"TPURGENT consumer group."
+],
+"readOnly": true,
+"type": "string"
 },
-"dbServerOcids": {
-"description": "Optional. OCID of database servers.",
-"items": {
+"displayName": {
+"description": "Output only. The display name for the database connection.",
+"readOnly": true,
 "type": "string"
 },
-"type": "array"
+"hostFormat": {
+"description": "Output only. The host name format being currently used in connection string.",
+"enum": [
+"HOST_FORMAT_UNSPECIFIED",
+"FQDN",
+"IP"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"FQDN",
+"IP"
+],
+"readOnly": true,
+"type": "string"
 },
-"diagnosticsDataCollectionOptions": {
-"$ref": "DataCollectionOptions",
-"description": "Optional. Data collection options for diagnostics."
+"isRegional": {
+"description": "Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.",
+"readOnly": true,
+"type": "boolean"
 },
-"diskRedundancy": {
-"description": "Optional. The type of redundancy.",
+"protocol": {
+"description": "Output only. The protocol being used by the connection.",
 "enum": [
-"DISK_REDUNDANCY_UNSPECIFIED",
-"HIGH",
-"NORMAL"
+"PROTOCOL_UNSPECIFIED",
+"TCP",
+"TCPS"
 ],
 "enumDescriptions": [
-"Unspecified.",
-"High - 3 way mirror.",
-"Normal - 2 way mirror."
+"Default unspecified value.",
+"Tcp",
+"Tcps"
 ],
+"readOnly": true,
 "type": "string"
 },
-"dnsListenerIp": {
-"description": "Output only. DNS listener IP.",
+"sessionMode": {
+"description": "Output only. The current session mode of the connection.",
+"enum": [
+"SESSION_MODE_UNSPECIFIED",
+"DIRECT",
+"INDIRECT"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"Direct",
+"Indirect"
+],
 "readOnly": true,
 "type": "string"
 },
-"domain": {
-"description": "Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com",
+"syntaxFormat": {
+"description": "Output only. The syntax of the connection string.",
+"enum": [
+"SYNTAX_FORMAT_UNSPECIFIED",
+"LONG",
+"EZCONNECT",
+"EZCONNECTPLUS"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"Long",
+"Ezconnect",
+"Ezconnectplus"
+],
 "readOnly": true,
 "type": "string"
 },
-"giVersion": {
-"description": "Optional. Grid Infrastructure Version.",
+"tlsAuthentication": {
+"description": "Output only. This field indicates the TLS authentication type of the connection.",
+"enum": [
+"TLS_AUTHENTICATION_UNSPECIFIED",
+"SERVER",
+"MUTUAL"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"Server",
+"Mutual"
+],
+"readOnly": true,
 "type": "string"
 },
-"hostname": {
-"description": "Output only. host name without domain. format: \"-\" with some suffix. ex: sp2-yi0xq where \"sp2\" is the hostname_prefix.",
+"value": {
+"description": "Output only. The value of the connection string.",
 "readOnly": true,
 "type": "string"
+}
 },
-"hostnamePrefix": {
-"description": "Optional. Prefix for VM cluster host names.",
-"type": "string"
+"type": "object"
 },
-"licenseType": {
-"description": "Required. License type of VM Cluster.",
+"DatabaseManagementConfig": {
+"description": "The configuration of the Database Management service.",
+"id": "DatabaseManagementConfig",
+"properties": {
+"managementState": {
+"description": "Output only. The status of the Database Management service.",
 "enum": [
-"LICENSE_TYPE_UNSPECIFIED",
-"LICENSE_INCLUDED",
-"BRING_YOUR_OWN_LICENSE"
+"MANAGEMENT_STATE_UNSPECIFIED",
+"ENABLING",
+"ENABLED",
+"DISABLING",
+"DISABLED",
+"UPDATING",
+"FAILED_ENABLING",
+"FAILED_DISABLING",
+"FAILED_UPDATING"
 ],
 "enumDescriptions": [
-"Unspecified",
-"License included part of offer",
-"Bring your own license"
+"The status is not specified.",
+"The Database Management service is enabling.",
+"The Database Management service is enabled.",
+"The Database Management service is disabling.",
+"The Database Management service is disabled.",
+"The Database Management service is updating.",
+"The Database Management service failed to enable.",
+"The Database Management service failed to disable.",
+"The Database Management service failed to update."
 ],
-"type": "string"
-},
-"localBackupEnabled": {
-"description": "Optional. Use local backup.",
-"type": "boolean"
-},
-"memorySizeGb": {
-"description": "Optional. Memory allocated in GBs.",
-"format": "int32",
-"type": "integer"
-},
-"nodeCount": {
-"description": "Optional. Number of database servers.",
-"format": "int32",
-"type": "integer"
-},
-"ociUrl": {
-"description": "Output only. Deep link to the OCI console to view this resource.",
 "readOnly": true,
 "type": "string"
 },
-"ocid": {
-"description": "Output only. Oracle Cloud Infrastructure ID of VM Cluster.",
+"managementType": {
+"description": "Output only. The Database Management type.",
+"enum": [
+"MANAGEMENT_TYPE_UNSPECIFIED",
+"BASIC",
+"ADVANCED"
+],
+"enumDescriptions": [
+"The type is not specified.",
+"Basic Database Management.",
+"Advanced Database Management."
+],
 "readOnly": true,
 "type": "string"
+}
 },
-"ocpuCount": {
-"description": "Optional. OCPU count per VM. Minimum is 0.1.",
-"format": "float",
-"type": "number"
+"type": "object"
 },
-"scanDns": {
-"description": "Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com",
-"readOnly": true,
-"type": "string"
+"DatabaseProperties": {
+"description": "The properties of a Database.",
+"id": "DatabaseProperties",
+"properties": {
+"databaseManagementConfig": {
+"$ref": "DatabaseManagementConfig",
+"description": "Output only. The Database Management config.",
+"readOnly": true
 },
-"scanDnsRecordId": {
-"description": "Output only. OCID of scan DNS record.",
-"readOnly": true,
-"type": "string"
+"dbBackupConfig": {
+"$ref": "DbBackupConfig",
+"description": "Optional. Backup options for the Database."
 },
-"scanIpIds": {
-"description": "Output only. OCIDs of scan IPs.",
-"items": {
+"dbVersion": {
+"description": "Required. The Oracle Database version.",
 "type": "string"
 },
+"state": {
+"description": "Output only. State of the Database.",
+"enum": [
+"DATABASE_LIFECYCLE_STATE_UNSPECIFIED",
+"PROVISIONING",
+"AVAILABLE",
+"UPDATING",
+"BACKUP_IN_PROGRESS",
+"UPGRADING",
+"CONVERTING",
+"TERMINATING",
+"TERMINATED",
+"RESTORE_FAILED",
+"FAILED"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"Indicates that the resource is in provisioning state.",
+"Indicates that the resource is in available state.",
+"Indicates that the resource is in updating state.",
+"Indicates that the resource is in backup in progress state.",
+"Indicates that the resource is in upgrading state.",
+"Indicates that the resource is in converting state.",
+"Indicates that the resource is in terminating state.",
+"Indicates that the resource is in terminated state.",
+"Indicates that the resource is in restore failed state.",
+"Indicates that the resource is in failed state."
+],
 "readOnly": true,
-"type": "array"
+"type": "string"
+}
 },
-"scanListenerPortTcp": {
-"description": "Output only. SCAN listener port - TCP",
-"format": "int32",
-"readOnly": true,
-"type": "integer"
+"type": "object"
 },
-"scanListenerPortTcpSsl": {
-"description": "Output only. SCAN listener port - TLS",
-"format": "int32",
-"readOnly": true,
-"type": "integer"
+"DbBackupConfig": {
+"description": "Backup Options for the Database.",
+"id": "DbBackupConfig",
+"properties": {
+"autoBackupEnabled": {
+"description": "Optional. If set to true, enables automatic backups on the database.",
+"type": "boolean"
 },
-"shape": {
-"description": "Output only. Shape of VM Cluster.",
-"readOnly": true,
+"autoFullBackupDay": {
+"description": "Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.",
+"enum": [
+"DAY_OF_WEEK_UNSPECIFIED",
+"MONDAY",
+"TUESDAY",
+"WEDNESDAY",
+"THURSDAY",
+"FRIDAY",
+"SATURDAY",
+"SUNDAY"
+],
+"enumDescriptions": [
+"The day of the week is unspecified.",
+"Monday",
+"Tuesday",
+"Wednesday",
+"Thursday",
+"Friday",
+"Saturday",
+"Sunday"
+],
+"type": "string"
+},
+"autoFullBackupWindow": {
+"description": "Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.",
+"enum": [
+"BACKUP_WINDOW_UNSPECIFIED",
+"SLOT_ONE",
+"SLOT_TWO",
+"SLOT_THREE",
+"SLOT_FOUR",
+"SLOT_FIVE",
+"SLOT_SIX",
+"SLOT_SEVEN",
+"SLOT_EIGHT",
+"SLOT_NINE",
+"SLOT_TEN",
+"SLOT_ELEVEN",
+"SLOT_TWELVE"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"12:00 AM - 2:00 AM",
+"2:00 AM - 4:00 AM",
+"4:00 AM - 6:00 AM",
+"6:00 AM - 8:00 AM",
+"8:00 AM - 10:00 AM",
+"10:00 AM - 12:00 PM",
+"12:00 PM - 2:00 PM",
+"2:00 PM - 4:00 PM",
+"4:00 PM - 6:00 PM",
+"6:00 PM - 8:00 PM",
+"8:00 PM - 10:00 PM",
+"10:00 PM - 12:00 AM"
+],
 "type": "string"
 },
-"sparseDiskgroupEnabled": {
-"description": "Optional. Use exadata sparse snapshots.",
-"type": "boolean"
-},
-"sshPublicKeys": {
-"description": "Optional. SSH public keys to be stored with cluster.",
-"items": {
+"autoIncrementalBackupWindow": {
+"description": "Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.",
+"enum": [
+"BACKUP_WINDOW_UNSPECIFIED",
+"SLOT_ONE",
+"SLOT_TWO",
+"SLOT_THREE",
+"SLOT_FOUR",
+"SLOT_FIVE",
+"SLOT_SIX",
+"SLOT_SEVEN",
+"SLOT_EIGHT",
+"SLOT_NINE",
+"SLOT_TEN",
+"SLOT_ELEVEN",
+"SLOT_TWELVE"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"12:00 AM - 2:00 AM",
+"2:00 AM - 4:00 AM",
+"4:00 AM - 6:00 AM",
+"6:00 AM - 8:00 AM",
+"8:00 AM - 10:00 AM",
+"10:00 AM - 12:00 PM",
+"12:00 PM - 2:00 PM",
+"2:00 PM - 4:00 PM",
+"4:00 PM - 6:00 PM",
+"6:00 PM - 8:00 PM",
+"8:00 PM - 10:00 PM",
+"10:00 PM - 12:00 AM"
+],
 "type": "string"
 },
-"type": "array"
-},
-"state": {
-"description": "Output only. State of the cluster.",
+"backupDeletionPolicy": {
+"description": "Optional. This defines when the backups will be deleted after Database termination.",
 "enum": [
-"STATE_UNSPECIFIED",
-"PROVISIONING",
-"AVAILABLE",
-"UPDATING",
-"TERMINATING",
-"TERMINATED",
-"FAILED",
-"MAINTENANCE_IN_PROGRESS"
+"BACKUP_DELETION_POLICY_UNSPECIFIED",
+"DELETE_IMMEDIATELY",
+"DELETE_AFTER_RETENTION_PERIOD"
 ],
 "enumDescriptions": [
 "Default unspecified value.",
-"Indicates that the resource is in provisioning state.",
-"Indicates that the resource is in available state.",
-"Indicates that the resource is in updating state.",
-"Indicates that the resource is in terminating state.",
-"Indicates that the resource is in terminated state.",
-"Indicates that the resource is in failed state.",
-"Indicates that the resource is in maintenance in progress state."
+"Keeps the backup for predefined time i.e. 72 hours and then delete permanently.",
+"Keeps the backups as per the policy defined for database backups."
 ],
-"readOnly": true,
 "type": "string"
 },
-"storageSizeGb": {
-"description": "Output only. The storage allocation for the disk group, in gigabytes (GB).",
-"format": "int32",
-"readOnly": true,
-"type": "integer"
+"backupDestinationDetails": {
+"description": "Optional. Details of the database backup destinations.",
+"items": {
+"$ref": "BackupDestinationDetails"
 },
-"systemVersion": {
-"description": "Optional. Operating system version of the image.",
-"type": "string"
+"type": "array"
 },
-"timeZone": {
-"$ref": "TimeZone",
-"description": "Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified."
+"retentionPeriodDays": {
+"description": "Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.",
+"format": "int32",
+"type": "integer"
 }
 },
 "type": "object"
 },
-"CustomerContact": {
-"description": "The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact",
-"id": "CustomerContact",
+"DbHome": {
+"description": "Details of the Database Home resource.",
+"id": "DbHome",
 "properties": {
-"email": {
-"description": "Required. The email address used by Oracle to send notifications regarding databases and infrastructure.",
-"type": "string"
-}
-},
-"type": "object"
+"database": {
+"$ref": "Database",
+"description": "Required. The Database resource."
 },
-"DataCollectionOptions": {
-"description": "Data collection options for diagnostics.",
-"id": "DataCollectionOptions",
-"properties": {
-"diagnosticsEventsEnabled": {
-"description": "Optional. Indicates whether diagnostic collection is enabled for the VM cluster",
-"type": "boolean"
+"dbVersion": {
+"description": "Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.",
+"type": "string"
 },
-"healthMonitoringEnabled": {
-"description": "Optional. Indicates whether health monitoring is enabled for the VM cluster",
-"type": "boolean"
+"displayName": {
+"description": "Optional. The display name for the Database Home. The name does not have to be unique within your project.",
+"type": "string"
 },
-"incidentLogsEnabled": {
-"description": "Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster",
+"isUnifiedAuditingEnabled": {
+"description": "Optional. Whether unified auditing is enabled for the Database Home.",
 "type": "boolean"
 }
 },
 "type": "object"
 },
-"DataCollectionOptionsDbSystem": {
-"description": "Data collection options for DbSystem.",
-"id": "DataCollectionOptionsDbSystem",
+"DbNode": {
+"description": "Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/",
+"id": "DbNode",
 "properties": {
-"isDiagnosticsEventsEnabled": {
-"description": "Optional. Indicates whether to enable data collection for diagnostics.",
-"type": "boolean"
+"name": {
+"description": "Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}",
+"type": "string"
 },
-"isIncidentLogsEnabled": {
-"description": "Optional. Indicates whether to enable incident logs and trace collection.",
-"type": "boolean"
+"properties": {
+"$ref": "DbNodeProperties",
+"description": "Optional. Various properties of the database node."
 }
 },
 "type": "object"
 },
-"Database": {
-"description": "Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/",
-"id": "Database",
+"DbNodeProperties": {
+"description": "Various properties and settings associated with Db node.",
+"id": "DbNodeProperties",
 "properties": {
-"adminPassword": {
-"description": "Required. The password for the default ADMIN user.",
-"type": "string"
-},
-"characterSet": {
-"description": "Optional. The character set for the database. The default is AL32UTF8.",
-"type": "string"
-},
 "createTime": {
-"description": "Output only. The date and time that the Database was created.",
+"description": "Output only. The date and time that the database node was created.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
 },
-"databaseId": {
-"description": "Optional. The database ID of the Database.",
-"type": "string"
+"dbNodeStorageSizeGb": {
+"description": "Optional. Local storage per database node.",
+"format": "int32",
+"type": "integer"
 },
-"dbHomeName": {
-"description": "Optional. The name of the DbHome resource associated with the Database.",
+"dbServerOcid": {
+"description": "Optional. Database server OCID.",
 "type": "string"
 },
-"dbName": {
-"description": "Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.",
+"hostname": {
+"description": "Optional. DNS",
 "type": "string"
 },
-"dbUniqueName": {
-"description": "Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.",
-"type": "string"
+"memorySizeGb": {
+"description": "Memory allocated in GBs.",
+"format": "int32",
+"type": "integer"
 },
-"gcpOracleZone": {
-"description": "Output only. The GCP Oracle zone where the Database is created.",
+"ocid": {
+"description": "Output only. OCID of database node.",
 "readOnly": true,
 "type": "string"
 },
-"name": {
-"description": "Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}",
-"type": "string"
-},
-"ncharacterSet": {
-"description": "Optional. The national character set for the database. The default is AL16UTF16.",
-"type": "string"
-},
-"ociUrl": {
-"description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.",
-"readOnly": true,
-"type": "string"
+"ocpuCount": {
+"description": "Optional. OCPU count per database node.",
+"format": "int32",
+"type": "integer"
 },
-"opsInsightsStatus": {
-"description": "Output only. The Status of Operations Insights for this Database.",
+"state": {
+"description": "Output only. State of the database node.",
 "enum": [
-"OPERATIONS_INSIGHTS_STATUS_UNSPECIFIED",
-"ENABLING",
-"ENABLED",
-"DISABLING",
-"NOT_ENABLED",
-"FAILED_ENABLING",
-"FAILED_DISABLING"
+"STATE_UNSPECIFIED",
+"PROVISIONING",
+"AVAILABLE",
+"UPDATING",
+"STOPPING",
+"STOPPED",
+"STARTING",
+"TERMINATING",
+"TERMINATED",
+"FAILED"
 ],
 "enumDescriptions": [
 "Default unspecified value.",
-"Indicates that the operations insights are being enabled.",
-"Indicates that the operations insights are enabled.",
-"Indicates that the operations insights are being disabled.",
-"Indicates that the operations insights are not enabled.",
-"Indicates that the operations insights failed to enable.",
-"Indicates that the operations insights failed to disable."
+"Indicates that the resource is in provisioning state.",
+"Indicates that the resource is in available state.",
+"Indicates that the resource is in updating state.",
+"Indicates that the resource is in stopping state.",
+"Indicates that the resource is in stopped state.",
+"Indicates that the resource is in starting state.",
+"Indicates that the resource is in terminating state.",
+"Indicates that the resource is in terminated state.",
+"Indicates that the resource is in failed state."
 ],
 "readOnly": true,
 "type": "string"
 },
+"totalCpuCoreCount": {
+"description": "Total CPU core count of the database node.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"DbServer": {
+"description": "Details of the database server resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/",
+"id": "DbServer",
 "properties": {
-"$ref": "DatabaseProperties",
-"description": "Optional. The properties of the Database."
+"displayName": {
+"description": "Optional. User friendly name for this resource.",
+"type": "string"
 },
-"tdeWalletPassword": {
-"description": "Optional. The TDE wallet password for the database.",
+"name": {
+"description": "Identifier. The name of the database server resource with the format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}",
 "type": "string"
+},
+"properties": {
+"$ref": "DbServerProperties",
+"description": "Optional. Various properties of the database server."
 }
 },
 "type": "object"
 },
-"DatabaseCharacterSet": {
-"description": "Details of the Database character set resource.",
-"id": "DatabaseCharacterSet",
+"DbServerProperties": {
+"description": "Various properties and settings associated with Exadata database server.",
+"id": "DbServerProperties",
 "properties": {
-"characterSet": {
-"description": "Output only. The character set name for the Database which is the ID in the resource name.",
+"dbNodeIds": {
+"description": "Output only. OCID of database nodes associated with the database server.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"dbNodeStorageSizeGb": {
+"description": "Optional. Local storage per VM.",
+"format": "int32",
+"type": "integer"
+},
+"maxDbNodeStorageSizeGb": {
+"description": "Optional. Maximum local storage per VM.",
+"format": "int32",
+"type": "integer"
+},
+"maxMemorySizeGb": {
+"description": "Optional. Maximum memory allocated in GBs.",
+"format": "int32",
+"type": "integer"
+},
+"maxOcpuCount": {
+"description": "Optional. Maximum OCPU count per database.",
+"format": "int32",
+"type": "integer"
+},
+"memorySizeGb": {
+"description": "Optional. Memory allocated in GBs.",
+"format": "int32",
+"type": "integer"
+},
+"ocid": {
+"description": "Output only. OCID of database server.",
 "readOnly": true,
 "type": "string"
 },
-"characterSetType": {
-"description": "Output only. The character set type for the Database.",
+"ocpuCount": {
+"description": "Optional. OCPU count per database.",
+"format": "int32",
+"type": "integer"
+},
+"state": {
+"description": "Output only. State of the database server.",
 "enum": [
-"CHARACTER_SET_TYPE_UNSPECIFIED",
-"DATABASE",
-"NATIONAL"
+"STATE_UNSPECIFIED",
+"CREATING",
+"AVAILABLE",
+"UNAVAILABLE",
+"DELETING",
+"DELETED"
 ],
 "enumDescriptions": [
-"Character set type is not specified.",
-"Character set type is set to database.",
-"Character set type is set to national."
+"Default unspecified value.",
+"Indicates that the resource is in creating state.",
+"Indicates that the resource is in available state.",
+"Indicates that the resource is in unavailable state.",
+"Indicates that the resource is in deleting state.",
+"Indicates that the resource is in deleted state."
 ],
 "readOnly": true,
 "type": "string"
 },
-"name": {
-"description": "Identifier. The name of the Database Character Set resource in the following format: projects/{project}/locations/{region}/databaseCharacterSets/{database_character_set}",
-"type": "string"
+"vmCount": {
+"description": "Optional. Vm count per database.",
+"format": "int32",
+"type": "integer"
 }
 },
 "type": "object"
 },
-"DatabaseConnectionStringProfile": {
-"description": "The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile",
-"id": "DatabaseConnectionStringProfile",
+"DbSystem": {
+"description": "Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/",
+"id": "DbSystem",
 "properties": {
-"consumerGroup": {
-"description": "Output only. The current consumer group being used by the connection.",
-"enum": [
-"CONSUMER_GROUP_UNSPECIFIED",
-"HIGH",
-"MEDIUM",
-"LOW",
-"TP",
-"TPURGENT"
-],
-"enumDescriptions": [
-"Default unspecified value.",
-"High consumer group.",
-"Medium consumer group.",
-"Low consumer group.",
-"TP consumer group.",
-"TPURGENT consumer group."
-],
+"createTime": {
+"description": "Output only. The date and time that the DbSystem was created.",
+"format": "google-datetime",
 "readOnly": true,
 "type": "string"
 },
 "displayName": {
-"description": "Output only. The display name for the database connection.",
-"readOnly": true,
+"description": "Required. The display name for the System db. The name does not have to be unique within your project.",
 "type": "string"
 },
-"hostFormat": {
-"description": "Output only. The host name format being currently used in connection string.",
-"enum": [
-"HOST_FORMAT_UNSPECIFIED",
-"FQDN",
-"IP"
-],
-"enumDescriptions": [
-"Default unspecified value.",
-"FQDN",
-"IP"
-],
+"entitlementId": {
+"description": "Output only. The ID of the subscription entitlement associated with the DbSystem",
 "readOnly": true,
 "type": "string"
 },
-"isRegional": {
-"description": "Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.",
-"readOnly": true,
-"type": "boolean"
+"gcpOracleZone": {
+"description": "Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.",
+"type": "string"
 },
-"protocol": {
-"description": "Output only. The protocol being used by the connection.",
-"enum": [
-"PROTOCOL_UNSPECIFIED",
-"TCP",
-"TCPS"
-],
-"enumDescriptions": [
-"Default unspecified value.",
-"Tcp",
-"Tcps"
-],
-"readOnly": true,
+"labels": {
+"additionalProperties": {
 "type": "string"
 },
-"sessionMode": {
-"description": "Output only. The current session mode of the connection.",
-"enum": [
-"SESSION_MODE_UNSPECIFIED",
-"DIRECT",
-"INDIRECT"
-],
-"enumDescriptions": [
-"Default unspecified value.",
-"Direct",
-"Indirect"
-],
-"readOnly": true,
+"description": "Optional. The labels or tags associated with the DbSystem.",
+"type": "object"
+},
+"name": {
+"description": "Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}",
 "type": "string"
 },
-"syntaxFormat": {
-"description": "Output only. The syntax of the connection string.",
-"enum": [
-"SYNTAX_FORMAT_UNSPECIFIED",
-"LONG",
-"EZCONNECT",
-"EZCONNECTPLUS"
-],
-"enumDescriptions": [
-"Default unspecified value.",
-"Long",
-"Ezconnect",
-"Ezconnectplus"
-],
+"ociUrl": {
+"description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.",
 "readOnly": true,
 "type": "string"
 },
-"tlsAuthentication": {
-"description": "Output only. This field indicates the TLS authentication type of the connection.",
-"enum": [
-"TLS_AUTHENTICATION_UNSPECIFIED",
-"SERVER",
-"MUTUAL"
-],
-"enumDescriptions": [
-"Default unspecified value.",
-"Server",
-"Mutual"
-],
-"readOnly": true,
+"odbNetwork": {
+"description": "Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.",
 "type": "string"
 },
-"value": {
-"description": "Output only. The value of the connection string.",
+"odbSubnet": {
+"description": "Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}",
+"type": "string"
+},
+"properties": {
+"$ref": "DbSystemProperties",
+"description": "Optional. The properties of the DbSystem."
+}
+},
+"type": "object"
+},
+"DbSystemInitialStorageSize": {
+"description": "Summary of the DbSystem initial storage size.",
+"id": "DbSystemInitialStorageSize",
+"properties": {
+"name": {
+"description": "Output only. The name of the resource.",
 "readOnly": true,
 "type": "string"
+},
+"properties": {
+"$ref": "DbSystemInitialStorageSizeProperties",
+"description": "Output only. The properties of the DbSystem initial storage size summary.",
+"readOnly": true
 }
 },
 "type": "object"
 },
-"DatabaseManagementConfig": {
-"description": "The configuration of the Database Management service.",
-"id": "DatabaseManagementConfig",
+"DbSystemInitialStorageSizeProperties": {
+"description": "The properties of a DbSystem initial storage size summary.",
+"id": "DbSystemInitialStorageSizeProperties",
 "properties": {
-"managementState": {
-"description": "Output only. The status of the Database Management service.",
-"enum": [
-"MANAGEMENT_STATE_UNSPECIFIED",
-"ENABLING",
-"ENABLED",
-"DISABLING",
-"DISABLED",
-"UPDATING",
-"FAILED_ENABLING",
-"FAILED_DISABLING",
-"FAILED_UPDATING"
+"launchFromBackupStorageSizeDetails": {
+"description": "Output only. List of storage disk details available for launches from backup.",
+"items": {
+"$ref": "StorageSizeDetails"
+},
+"readOnly": true,
+"type": "array"
+},
+"shapeType": {
+"description": "Output only. VM shape platform type",
+"enum": [
+"SHAPE_TYPE_UNSPECIFIED",
+"STANDARD_X86"
 ],
 "enumDescriptions": [
-"The status is not specified.",
-"The Database Management service is enabling.",
-"The Database Management service is enabled.",
-"The Database Management service is disabling.",
-"The Database Management service is disabled.",
-"The Database Management service is updating.",
-"The Database Management service failed to enable.",
-"The Database Management service failed to disable.",
-"The Database Management service failed to update."
+"Unspecified shape type.",
+"Standard X86."
 ],
 "readOnly": true,
 "type": "string"
 },
-"managementType": {
-"description": "Output only. The Database Management type.",
+"storageManagement": {
+"description": "Output only. The storage option used in DB system.",
 "enum": [
-"MANAGEMENT_TYPE_UNSPECIFIED",
-"BASIC",
-"ADVANCED"
+"STORAGE_MANAGEMENT_UNSPECIFIED",
+"ASM",
+"LVM"
 ],
 "enumDescriptions": [
-"The type is not specified.",
-"Basic Database Management.",
-"Advanced Database Management."
+"Unspecified storage management.",
+"Automatic Storage Management.",
+"Logical Volume Management."
 ],
 "readOnly": true,
 "type": "string"
+},
+"storageSizeDetails": {
+"description": "Output only. List of storage disk details.",
+"items": {
+"$ref": "StorageSizeDetails"
+},
+"readOnly": true,
+"type": "array"
 }
 },
 "type": "object"
 },
-"DatabaseProperties": {
-"description": "The properties of a Database.",
-"id": "DatabaseProperties",
+"DbSystemOptions": {
+"description": "Details of the DbSystem Options.",
+"id": "DbSystemOptions",
 "properties": {
-"databaseManagementConfig": {
-"$ref": "DatabaseManagementConfig",
-"description": "Output only. The Database Management config.",
-"readOnly": true
-},
-"dbBackupConfig": {
-"$ref": "DbBackupConfig",
-"description": "Optional. Backup options for the Database."
-},
-"dbVersion": {
-"description": "Required. The Oracle Database version.",
-"type": "string"
-},
-"state": {
-"description": "Output only. State of the Database.",
+"storageManagement": {
+"description": "Optional. The storage option used in DB system.",
 "enum": [
-"DATABASE_LIFECYCLE_STATE_UNSPECIFIED",
-"PROVISIONING",
-"AVAILABLE",
-"UPDATING",
-"BACKUP_IN_PROGRESS",
-"UPGRADING",
-"CONVERTING",
-"TERMINATING",
-"TERMINATED",
-"RESTORE_FAILED",
-"FAILED"
+"STORAGE_MANAGEMENT_UNSPECIFIED",
+"ASM",
+"LVM"
 ],
 "enumDescriptions": [
-"Default unspecified value.",
-"Indicates that the resource is in provisioning state.",
-"Indicates that the resource is in available state.",
-"Indicates that the resource is in updating state.",
-"Indicates that the resource is in backup in progress state.",
-"Indicates that the resource is in upgrading state.",
-"Indicates that the resource is in converting state.",
-"Indicates that the resource is in terminating state.",
-"Indicates that the resource is in terminated state.",
-"Indicates that the resource is in restore failed state.",
-"Indicates that the resource is in failed state."
+"The storage management is unspecified.",
+"Automatic storage management.",
+"Logical Volume management."
 ],
-"readOnly": true,
 "type": "string"
 }
 },
 "type": "object"
 },
-"DbBackupConfig": {
-"description": "Backup Options for the Database.",
-"id": "DbBackupConfig",
+"DbSystemProperties": {
+"description": "The properties of a DbSystem.",
+"id": "DbSystemProperties",
 "properties": {
-"autoBackupEnabled": {
-"description": "Optional. If set to true, enables automatic backups on the database.",
-"type": "boolean"
+"computeCount": {
+"description": "Required. The number of CPU cores to enable for the DbSystem.",
+"format": "int32",
+"type": "integer"
 },
-"autoFullBackupDay": {
-"description": "Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.",
+"computeModel": {
+"description": "Optional. The compute model of the DbSystem.",
 "enum": [
-"DAY_OF_WEEK_UNSPECIFIED",
-"MONDAY",
-"TUESDAY",
-"WEDNESDAY",
-"THURSDAY",
-"FRIDAY",
-"SATURDAY",
-"SUNDAY"
+"COMPUTE_MODEL_UNSPECIFIED",
+"ECPU",
+"OCPU"
 ],
 "enumDescriptions": [
-"The day of the week is unspecified.",
-"Monday",
-"Tuesday",
-"Wednesday",
-"Thursday",
-"Friday",
-"Saturday",
-"Sunday"
+"The compute model is unspecified.",
+"The compute model is virtual.",
+"The compute model is physical."
 ],
 "type": "string"
 },
-"autoFullBackupWindow": {
-"description": "Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.",
+"dataCollectionOptions": {
+"$ref": "DataCollectionOptionsDbSystem",
+"description": "Optional. Data collection options for diagnostics."
+},
+"dataStorageSizeGb": {
+"description": "Optional. The data storage size in GB that is currently available to DbSystems.",
+"format": "int32",
+"type": "integer"
+},
+"databaseEdition": {
+"description": "Required. The database edition of the DbSystem.",
 "enum": [
-"BACKUP_WINDOW_UNSPECIFIED",
-"SLOT_ONE",
-"SLOT_TWO",
-"SLOT_THREE",
-"SLOT_FOUR",
-"SLOT_FIVE",
-"SLOT_SIX",
-"SLOT_SEVEN",
-"SLOT_EIGHT",
-"SLOT_NINE",
-"SLOT_TEN",
-"SLOT_ELEVEN",
-"SLOT_TWELVE"
+"DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED",
+"STANDARD_EDITION",
+"ENTERPRISE_EDITION",
+"ENTERPRISE_EDITION_HIGH_PERFORMANCE"
 ],
 "enumDescriptions": [
-"Default unspecified value.",
-"12:00 AM - 2:00 AM",
-"2:00 AM - 4:00 AM",
-"4:00 AM - 6:00 AM",
-"6:00 AM - 8:00 AM",
-"8:00 AM - 10:00 AM",
-"10:00 AM - 12:00 PM",
-"12:00 PM - 2:00 PM",
-"2:00 PM - 4:00 PM",
-"4:00 PM - 6:00 PM",
-"6:00 PM - 8:00 PM",
-"8:00 PM - 10:00 PM",
-"10:00 PM - 12:00 AM"
+"The database edition is unspecified.",
+"The database edition is Standard.",
+"The database edition is Enterprise.",
+"The database edition is Enterprise Edition."
 ],
 "type": "string"
 },
-"autoIncrementalBackupWindow": {
-"description": "Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.",
+"dbHome": {
+"$ref": "DbHome",
+"description": "Optional. Details for creating a Database Home."
+},
+"dbSystemOptions": {
+"$ref": "DbSystemOptions",
+"description": "Optional. The options for the DbSystem."
+},
+"domain": {
+"description": "Optional. The host domain name of the DbSystem.",
+"type": "string"
+},
+"hostname": {
+"description": "Output only. The hostname of the DbSystem.",
+"readOnly": true,
+"type": "string"
+},
+"hostnamePrefix": {
+"description": "Optional. Prefix for DB System host names.",
+"type": "string"
+},
+"initialDataStorageSizeGb": {
+"description": "Required. The initial data storage size in GB.",
+"format": "int32",
+"type": "integer"
+},
+"licenseModel": {
+"description": "Required. The license model of the DbSystem.",
 "enum": [
-"BACKUP_WINDOW_UNSPECIFIED",
-"SLOT_ONE",
-"SLOT_TWO",
-"SLOT_THREE",
-"SLOT_FOUR",
-"SLOT_FIVE",
-"SLOT_SIX",
-"SLOT_SEVEN",
-"SLOT_EIGHT",
-"SLOT_NINE",
-"SLOT_TEN",
-"SLOT_ELEVEN",
-"SLOT_TWELVE"
+"LICENSE_MODEL_UNSPECIFIED",
+"LICENSE_INCLUDED",
+"BRING_YOUR_OWN_LICENSE"
 ],
 "enumDescriptions": [
-"Default unspecified value.",
-"12:00 AM - 2:00 AM",
-"2:00 AM - 4:00 AM",
-"4:00 AM - 6:00 AM",
-"6:00 AM - 8:00 AM",
-"8:00 AM - 10:00 AM",
-"10:00 AM - 12:00 PM",
-"12:00 PM - 2:00 PM",
-"2:00 PM - 4:00 PM",
-"4:00 PM - 6:00 PM",
-"6:00 PM - 8:00 PM",
-"8:00 PM - 10:00 PM",
-"10:00 PM - 12:00 AM"
+"The license model is unspecified.",
+"The license model is included.",
+"The license model is bring your own license."
 ],
 "type": "string"
 },
-"backupDeletionPolicy": {
-"description": "Optional. This defines when the backups will be deleted after Database termination.",
+"lifecycleState": {
+"description": "Output only. State of the DbSystem.",
 "enum": [
-"BACKUP_DELETION_POLICY_UNSPECIFIED",
-"DELETE_IMMEDIATELY",
-"DELETE_AFTER_RETENTION_PERIOD"
+"DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED",
+"PROVISIONING",
+"AVAILABLE",
+"UPDATING",
+"TERMINATING",
+"TERMINATED",
+"FAILED",
+"MIGRATED",
+"MAINTENANCE_IN_PROGRESS",
+"NEEDS_ATTENTION",
+"UPGRADING"
 ],
 "enumDescriptions": [
 "Default unspecified value.",
-"Keeps the backup for predefined time i.e. 72 hours and then delete permanently.",
-"Keeps the backups as per the policy defined for database backups."
+"Indicates that the resource is in provisioning state.",
+"Indicates that the resource is in available state.",
+"Indicates that the resource is in updating state.",
+"Indicates that the resource is in terminating state.",
+"Indicates that the resource is in terminated state.",
+"Indicates that the resource is in failed state.",
+"Indicates that the resource has been migrated.",
+"Indicates that the resource is in maintenance in progress state.",
+"Indicates that the resource needs attention.",
+"Indicates that the resource is upgrading."
 ],
+"readOnly": true,
 "type": "string"
 },
-"backupDestinationDetails": {
-"description": "Optional. Details of the database backup destinations.",
-"items": {
-"$ref": "BackupDestinationDetails"
-},
-"type": "array"
-},
-"retentionPeriodDays": {
-"description": "Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.",
+"memorySizeGb": {
+"description": "Optional. The memory size in GB.",
 "format": "int32",
 "type": "integer"
-}
 },
-"type": "object"
-},
-"DbHome": {
-"description": "Details of the Database Home resource.",
-"id": "DbHome",
-"properties": {
-"database": {
-"$ref": "Database",
-"description": "Required. The Database resource."
+"nodeCount": {
+"description": "Optional. The number of nodes in the DbSystem.",
+"format": "int32",
+"type": "integer"
 },
-"dbVersion": {
-"description": "Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.",
+"ocid": {
+"description": "Output only. OCID of the DbSystem.",
+"readOnly": true,
 "type": "string"
 },
-"displayName": {
-"description": "Optional. The display name for the Database Home. The name does not have to be unique within your project.",
+"privateIp": {
+"description": "Optional. The private IP address of the DbSystem.",
 "type": "string"
 },
-"isUnifiedAuditingEnabled": {
-"description": "Optional. Whether unified auditing is enabled for the Database Home.",
-"type": "boolean"
-}
+"recoStorageSizeGb": {
+"description": "Optional. The reco/redo storage size in GB.",
+"format": "int32",
+"type": "integer"
 },
-"type": "object"
+"shape": {
+"description": "Required. Shape of DB System.",
+"type": "string"
 },
-"DbNode": {
-"description": "Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/",
-"id": "DbNode",
-"properties": {
-"name": {
-"description": "Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}",
+"sshPublicKeys": {
+"description": "Required. SSH public keys to be stored with the DbSystem.",
+"items": {
 "type": "string"
 },
-"properties": {
-"$ref": "DbNodeProperties",
-"description": "Optional. Various properties of the database node."
+"type": "array"
+},
+"timeZone": {
+"$ref": "TimeZone",
+"description": "Optional. Time zone of the DbSystem."
 }
 },
 "type": "object"
 },
-"DbNodeProperties": {
-"description": "Various properties and settings associated with Db node.",
-"id": "DbNodeProperties",
+"DbSystemShape": {
+"description": "Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/",
+"id": "DbSystemShape",
 "properties": {
-"createTime": {
-"description": "Output only. The date and time that the database node was created.",
-"format": "google-datetime",
-"readOnly": true,
-"type": "string"
+"availableCoreCountPerNode": {
+"description": "Optional. Number of cores per node.",
+"format": "int32",
+"type": "integer"
 },
-"dbNodeStorageSizeGb": {
-"description": "Optional. Local storage per database node.",
+"availableDataStorageTb": {
+"description": "Optional. Storage per storage server in terabytes.",
 "format": "int32",
 "type": "integer"
 },
-"dbServerOcid": {
-"description": "Optional. Database server OCID.",
-"type": "string"
+"availableMemoryPerNodeGb": {
+"description": "Optional. Memory per database server node in gigabytes.",
+"format": "int32",
+"type": "integer"
 },
-"hostname": {
-"description": "Optional. DNS",
-"type": "string"
+"maxNodeCount": {
+"description": "Optional. Maximum number of database servers.",
+"format": "int32",
+"type": "integer"
 },
-"memorySizeGb": {
-"description": "Memory allocated in GBs.",
+"maxStorageCount": {
+"description": "Optional. Maximum number of storage servers.",
 "format": "int32",
 "type": "integer"
 },
-"ocid": {
-"description": "Output only. OCID of database node.",
-"readOnly": true,
-"type": "string"
+"minCoreCountPerNode": {
+"description": "Optional. Minimum core count per node.",
+"format": "int32",
+"type": "integer"
 },
-"ocpuCount": {
-"description": "Optional. OCPU count per database node.",
+"minDbNodeStoragePerNodeGb": {
+"description": "Optional. Minimum node storage per database server in gigabytes.",
 "format": "int32",
 "type": "integer"
 },
-"state": {
-"description": "Output only. State of the database node.",
-"enum": [
-"STATE_UNSPECIFIED",
-"PROVISIONING",
-"AVAILABLE",
-"UPDATING",
-"STOPPING",
-"STOPPED",
-"STARTING",
-"TERMINATING",
-"TERMINATED",
-"FAILED"
-],
-"enumDescriptions": [
-"Default unspecified value.",
-"Indicates that the resource is in provisioning state.",
-"Indicates that the resource is in available state.",
-"Indicates that the resource is in updating state.",
-"Indicates that the resource is in stopping state.",
-"Indicates that the resource is in stopped state.",
-"Indicates that the resource is in starting state.",
-"Indicates that the resource is in terminating state.",
-"Indicates that the resource is in terminated state.",
-"Indicates that the resource is in failed state."
-],
-"readOnly": true,
-"type": "string"
+"minMemoryPerNodeGb": {
+"description": "Optional. Minimum memory per node in gigabytes.",
+"format": "int32",
+"type": "integer"
 },
-"totalCpuCoreCount": {
-"description": "Total CPU core count of the database node.",
+"minNodeCount": {
+"description": "Optional. Minimum number of database servers.",
 "format": "int32",
 "type": "integer"
+},
+"minStorageCount": {
+"description": "Optional. Minimum number of storage servers.",
+"format": "int32",
+"type": "integer"
+},
+"name": {
+"description": "Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape}",
+"type": "string"
+},
+"shape": {
+"description": "Optional. shape",
+"type": "string"
 }
 },
 "type": "object"
 },
-"DbServer": {
-"description": "Details of the database server resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/",
-"id": "DbServer",
+"DbVersion": {
+"description": "A valid Oracle Database version.",
+"id": "DbVersion",
 "properties": {
-"displayName": {
-"description": "Optional. User friendly name for this resource.",
-"type": "string"
-},
 "name": {
-"description": "Identifier. The name of the database server resource with the format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}",
+"description": "Output only. The name of the DbVersion resource in the following format: projects/{project}/locations/{region}/dbVersions/{db_version}",
+"readOnly": true,
 "type": "string"
 },
 "properties": {
-"$ref": "DbServerProperties",
-"description": "Optional. Various properties of the database server."
+"$ref": "DbVersionProperties",
+"description": "Output only. The properties of the DbVersion.",
+"readOnly": true
 }
 },
 "type": "object"
 },
-"DbServerProperties": {
-"description": "Various properties and settings associated with Exadata database server.",
-"id": "DbServerProperties",
+"DbVersionProperties": {
+"description": "The properties of a DbVersion.",
+"id": "DbVersionProperties",
 "properties": {
-"dbNodeIds": {
-"description": "Output only. OCID of database nodes associated with the database server.",
-"items": {
-"type": "string"
+"isLatestForMajorVersion": {
+"description": "Output only. True if this version of the Oracle Database software is the latest version for a release.",
+"readOnly": true,
+"type": "boolean"
 },
+"isPreviewDbVersion": {
+"description": "Output only. True if this version of the Oracle Database software is the preview version.",
 "readOnly": true,
-"type": "array"
+"type": "boolean"
 },
-"dbNodeStorageSizeGb": {
-"description": "Optional. Local storage per VM.",
-"format": "int32",
-"type": "integer"
+"isUpgradeSupported": {
+"description": "Output only. True if this version of the Oracle Database software is supported for Upgrade.",
+"readOnly": true,
+"type": "boolean"
 },
-"maxDbNodeStorageSizeGb": {
-"description": "Optional. Maximum local storage per VM.",
-"format": "int32",
-"type": "integer"
+"supportsPdb": {
+"description": "Output only. True if this version of the Oracle Database software supports pluggable databases.",
+"readOnly": true,
+"type": "boolean"
 },
-"maxMemorySizeGb": {
-"description": "Optional. Maximum memory allocated in GBs.",
-"format": "int32",
-"type": "integer"
+"version": {
+"description": "Output only. A valid Oracle Database version.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"DefinedTagValue": {
+"description": "Wrapper message for the value of a defined tag.",
+"id": "DefinedTagValue",
+"properties": {
+"tags": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "The tags within the namespace.",
+"type": "object"
+}
 },
-"maxOcpuCount": {
-"description": "Optional. Maximum OCPU count per database.",
-"format": "int32",
-"type": "integer"
+"type": "object"
 },
-"memorySizeGb": {
-"description": "Optional. Memory allocated in GBs.",
-"format": "int32",
-"type": "integer"
+"Empty": {
+"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
+"id": "Empty",
+"properties": {},
+"type": "object"
 },
-"ocid": {
-"description": "Output only. OCID of database server.",
+"Entitlement": {
+"description": "Details of the Entitlement resource.",
+"id": "Entitlement",
+"properties": {
+"cloudAccountDetails": {
+"$ref": "CloudAccountDetails",
+"description": "Details of the OCI Cloud Account."
+},
+"entitlementId": {
+"description": "Output only. Google Cloud Marketplace order ID (aka entitlement ID)",
 "readOnly": true,
 "type": "string"
 },
-"ocpuCount": {
-"description": "Optional. OCPU count per database.",
-"format": "int32",
-"type": "integer"
+"name": {
+"description": "Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement}",
+"type": "string"
 },
 "state": {
-"description": "Output only. State of the database server.",
+"description": "Output only. Entitlement State.",
 "enum": [
 "STATE_UNSPECIFIED",
-"CREATING",
-"AVAILABLE",
-"UNAVAILABLE",
-"DELETING",
-"DELETED"
+"ACCOUNT_NOT_LINKED",
+"ACCOUNT_NOT_ACTIVE",
+"ACTIVE",
+"ACCOUNT_SUSPENDED",
+"NOT_APPROVED_IN_PRIVATE_MARKETPLACE"
 ],
 "enumDescriptions": [
 "Default unspecified value.",
-"Indicates that the resource is in creating state.",
-"Indicates that the resource is in available state.",
-"Indicates that the resource is in unavailable state.",
-"Indicates that the resource is in deleting state.",
-"Indicates that the resource is in deleted state."
+"Account not linked.",
+"Account is linked but not active.",
+"Entitlement and Account are active.",
+"Account is suspended.",
+"Entitlement is not approved in private marketplace."
 ],
 "readOnly": true,
 "type": "string"
-},
-"vmCount": {
-"description": "Optional. Vm count per database.",
-"format": "int32",
-"type": "integer"
 }
 },
 "type": "object"
 },
-"DbSystem": {
-"description": "Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/",
-"id": "DbSystem",
+"ExadbVmCluster": {
+"description": "ExadbVmCluster represents a cluster of VMs that are used to run Exadata workloads. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExadbVmCluster/",
+"id": "ExadbVmCluster",
 "properties": {
+"backupOdbSubnet": {
+"description": "Required. Immutable. The name of the backup OdbSubnet associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}",
+"type": "string"
+},
 "createTime": {
-"description": "Output only. The date and time that the DbSystem was created.",
+"description": "Output only. The date and time that the ExadbVmCluster was created.",
 "format": "google-datetime",
 "readOnly": true,
 "type": "string"
 },
 "displayName": {
-"description": "Required. The display name for the System db. The name does not have to be unique within your project.",
+"description": "Required. Immutable. The display name for the ExadbVmCluster. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.",
 "type": "string"
 },
 "entitlementId": {
-"description": "Output only. The ID of the subscription entitlement associated with the DbSystem",
+"description": "Output only. The ID of the subscription entitlement associated with the ExadbVmCluster.",
 "readOnly": true,
 "type": "string"
 },
 "gcpOracleZone": {
-"description": "Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.",
+"description": "Output only. Immutable. The GCP Oracle zone where Oracle ExadbVmCluster is hosted. Example: us-east4-b-r2. During creation, the system will pick the zone assigned to the ExascaleDbStorageVault.",
+"readOnly": true,
 "type": "string"
 },
 "labels": {
 "additionalProperties": {
 "type": "string"
 },
-"description": "Optional. The labels or tags associated with the DbSystem.",
+"description": "Optional. The labels or tags associated with the ExadbVmCluster.",
 "type": "object"
 },
 "name": {
-"description": "Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}",
-"type": "string"
-},
-"ociUrl": {
-"description": "Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.",
-"readOnly": true,
+"description": "Identifier. The name of the ExadbVmCluster resource in the following format: projects/{project}/locations/{region}/exadbVmClusters/{exadb_vm_cluster}",
 "type": "string"
 },
 "odbNetwork": {
-"description": "Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.",
+"description": "Optional. Immutable. The name of the OdbNetwork associated with the ExadbVmCluster. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.",
 "type": "string"
 },
 "odbSubnet": {
-"description": "Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}",
-"type": "string"
-},
-"properties": {
-"$ref": "DbSystemProperties",
-"description": "Optional. The properties of the DbSystem."
-}
-},
-"type": "object"
-},
-"DbSystemInitialStorageSize": {
-"description": "Summary of the DbSystem initial storage size.",
-"id": "DbSystemInitialStorageSize",
-"properties": {
-"name": {
-"description": "Output only. The name of the resource.",
-"readOnly": true,
-"type": "string"
-},
-"properties": {
-"$ref": "DbSystemInitialStorageSizeProperties",
-"description": "Output only. The properties of the DbSystem initial storage size summary.",
-"readOnly": true
-}
-},
-"type": "object"
-},
-"DbSystemInitialStorageSizeProperties": {
-"description": "The properties of a DbSystem initial storage size summary.",
-"id": "DbSystemInitialStorageSizeProperties",
-"properties": {
-"launchFromBackupStorageSizeDetails": {
-"description": "Output only. List of storage disk details available for launches from backup.",
-"items": {
-"$ref": "StorageSizeDetails"
-},
-"readOnly": true,
-"type": "array"
-},
-"shapeType": {
-"description": "Output only. VM shape platform type",
-"enum": [
-"SHAPE_TYPE_UNSPECIFIED",
-"STANDARD_X86"
-],
-"enumDescriptions": [
-"Unspecified shape type.",
-"Standard X86."
-],
-"readOnly": true,
-"type": "string"
-},
-"storageManagement": {
-"description": "Output only. The storage option used in DB system.",
-"enum": [
-"STORAGE_MANAGEMENT_UNSPECIFIED",
-"ASM",
-"LVM"
-],
-"enumDescriptions": [
-"Unspecified storage management.",
-"Automatic Storage Management.",
-"Logical Volume Management."
-],
-"readOnly": true,
+"description": "Required. Immutable. The name of the OdbSubnet associated with the ExadbVmCluster for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}",
 "type": "string"
 },
-"storageSizeDetails": {
-"description": "Output only. List of storage disk details.",
-"items": {
-"$ref": "StorageSizeDetails"
-},
-"readOnly": true,
-"type": "array"
-}
-},
-"type": "object"
-},
-"DbSystemOptions": {
-"description": "Details of the DbSystem Options.",
-"id": "DbSystemOptions",
 "properties": {
-"storageManagement": {
-"description": "Optional. The storage option used in DB system.",
-"enum": [
-"STORAGE_MANAGEMENT_UNSPECIFIED",
-"ASM",
-"LVM"
-],
-"enumDescriptions": [
-"The storage management is unspecified.",
-"Automatic storage management.",
-"Logical Volume management."
-],
-"type": "string"
+"$ref": "ExadbVmClusterProperties",
+"description": "Required. The properties of the ExadbVmCluster."
 }
 },
 "type": "object"
 },
-"DbSystemProperties": {
-"description": "The properties of a DbSystem.",
-"id": "DbSystemProperties",
+"ExadbVmClusterProperties": {
+"description": "The properties of an ExadbVmCluster.",
+"id": "ExadbVmClusterProperties",
 "properties": {
-"computeCount": {
-"description": "Required. The number of CPU cores to enable for the DbSystem.",
+"additionalEcpuCountPerNode": {
+"description": "Optional. Immutable. The number of additional ECPUs per node for an Exadata VM cluster on exascale infrastructure.",
 "format": "int32",
 "type": "integer"
 },
-"computeModel": {
-"description": "Optional. The compute model of the DbSystem.",
-"enum": [
-"COMPUTE_MODEL_UNSPECIFIED",
-"ECPU",
-"OCPU"
-],
-"enumDescriptions": [
-"The compute model is unspecified.",
-"The compute model is virtual.",
-"The compute model is physical."
-],
+"clusterName": {
+"description": "Optional. Immutable. The cluster name for Exascale vm cluster. The cluster name must begin with an alphabetic character and may contain hyphens(-) but can not contain underscores(_). It should be not more than 11 characters and is not case sensitive. OCI Cluster name.",
 "type": "string"
 },
 "dataCollectionOptions": {
-"$ref": "DataCollectionOptionsDbSystem",
-"description": "Optional. Data collection options for diagnostics."
+"$ref": "DataCollectionOptionsCommon",
+"description": "Optional. Immutable. Indicates user preference for data collection options."
 },
-"dataStorageSizeGb": {
-"description": "Optional. The data storage size in GB that is currently available to DbSystems.",
+"enabledEcpuCountPerNode": {
+"description": "Required. Immutable. The number of ECPUs enabled per node for an exadata vm cluster on exascale infrastructure.",
 "format": "int32",
 "type": "integer"
 },
-"databaseEdition": {
-"description": "Required. The database edition of the DbSystem.",
-"enum": [
-"DB_SYSTEM_DATABASE_EDITION_UNSPECIFIED",
-"STANDARD_EDITION",
-"ENTERPRISE_EDITION",
-"ENTERPRISE_EDITION_HIGH_PERFORMANCE"
-],
-"enumDescriptions": [
-"The database edition is unspecified.",
-"The database edition is Standard.",
-"The database edition is Enterprise.",
-"The database edition is Enterprise Edition."
-],
+"exascaleDbStorageVault": {
+"description": "Required. Immutable. The name of ExascaleDbStorageVault associated with the ExadbVmCluster. It can refer to an existing ExascaleDbStorageVault. Or a new one can be created during the ExadbVmCluster creation (requires storage_vault_properties to be set). Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}",
 "type": "string"
 },
-"dbHome": {
-"$ref": "DbHome",
-"description": "Optional. Details for creating a Database Home."
-},
-"dbSystemOptions": {
-"$ref": "DbSystemOptions",
-"description": "Optional. The options for the DbSystem."
+"giVersion": {
+"description": "Output only. The Oracle Grid Infrastructure (GI) software version.",
+"readOnly": true,
+"type": "string"
 },
-"domain": {
-"description": "Optional. The host domain name of the DbSystem.",
+"gridImageId": {
+"description": "Required. Immutable. Grid Infrastructure Version.",
 "type": "string"
 },
 "hostname": {
-"description": "Output only. The hostname of the DbSystem.",
+"description": "Output only. The hostname of the ExadbVmCluster.",
 "readOnly": true,
 "type": "string"
 },
 "hostnamePrefix": {
-"description": "Optional. Prefix for DB System host names.",
+"description": "Required. Immutable. Prefix for VM cluster host names.",
 "type": "string"
 },
-"initialDataStorageSizeGb": {
-"description": "Required. The initial data storage size in GB.",
-"format": "int32",
-"type": "integer"
-},
 "licenseModel": {
-"description": "Required. The license model of the DbSystem.",
+"description": "Optional. Immutable. The license type of the ExadbVmCluster.",
 "enum": [
 "LICENSE_MODEL_UNSPECIFIED",
 "LICENSE_INCLUDED",
 "BRING_YOUR_OWN_LICENSE"
 ],
 "enumDescriptions": [
-"The license model is unspecified.",
-"The license model is included.",
-"The license model is bring your own license."
+"Unspecified.",
+"Default is license included.",
+"Bring your own license."
 ],
 "type": "string"
 },
 "lifecycleState": {
-"description": "Output only. State of the DbSystem.",
+"description": "Output only. State of the cluster.",
 "enum": [
-"DB_SYSTEM_LIFECYCLE_STATE_UNSPECIFIED",
+"EXADB_VM_CLUSTER_LIFECYCLE_STATE_UNSPECIFIED",
 "PROVISIONING",
 "AVAILABLE",
 "UPDATING",
 "TERMINATING",
 "TERMINATED",
 "FAILED",
-"MIGRATED",
-"MAINTENANCE_IN_PROGRESS",
-"NEEDS_ATTENTION",
-"UPGRADING"
+"MAINTENANCE_IN_PROGRESS"
 ],
 "enumDescriptions": [
 "Default unspecified value.",
@@ -4587,44 +5391,48 @@
 "Indicates that the resource is in terminating state.",
 "Indicates that the resource is in terminated state.",
 "Indicates that the resource is in failed state.",
-"Indicates that the resource has been migrated.",
-"Indicates that the resource is in maintenance in progress state.",
-"Indicates that the resource needs attention.",
-"Indicates that the resource is upgrading."
+"Indicates that the resource is in maintenance in progress state."
 ],
 "readOnly": true,
 "type": "string"
 },
 "memorySizeGb": {
-"description": "Optional. The memory size in GB.",
+"description": "Output only. Memory per VM (GB) (Read-only): Shows the amount of memory allocated to each VM. Memory is calculated based on 2.75 GB per Total ECPUs.",
 "format": "int32",
+"readOnly": true,
 "type": "integer"
 },
 "nodeCount": {
-"description": "Optional. The number of nodes in the DbSystem.",
+"description": "Required. The number of nodes/VMs in the ExadbVmCluster.",
 "format": "int32",
 "type": "integer"
 },
-"ocid": {
-"description": "Output only. OCID of the DbSystem.",
+"ociUri": {
+"description": "Output only. Deep link to the OCI console to view this resource.",
 "readOnly": true,
 "type": "string"
 },
-"privateIp": {
-"description": "Optional. The private IP address of the DbSystem.",
-"type": "string"
-},
-"recoStorageSizeGb": {
-"description": "Optional. The reco/redo storage size in GB.",
+"scanListenerPortTcp": {
+"description": "Optional. Immutable. SCAN listener port - TCP",
 "format": "int32",
 "type": "integer"
 },
-"shape": {
-"description": "Required. Shape of DB System.",
+"shapeAttribute": {
+"description": "Required. Immutable. The shape attribute of the VM cluster. The type of Exascale storage used for Exadata VM cluster. The default is SMART_STORAGE which supports Oracle Database 23ai and later",
+"enum": [
+"SHAPE_ATTRIBUTE_UNSPECIFIED",
+"SMART_STORAGE",
+"BLOCK_STORAGE"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"Indicates that the resource is in smart storage.",
+"Indicates that the resource is in block storage."
+],
 "type": "string"
 },
 "sshPublicKeys": {
-"description": "Required. SSH public keys to be stored with the DbSystem.",
+"description": "Required. Immutable. The SSH public keys for the ExadbVmCluster.",
 "items": {
 "type": "string"
 },
@@ -4632,182 +5440,201 @@
 },
 "timeZone": {
 "$ref": "TimeZone",
-"description": "Optional. Time zone of the DbSystem."
+"description": "Optional. Immutable. The time zone of the ExadbVmCluster."
+},
+"vmFileSystemStorage": {
+"$ref": "ExadbVmClusterStorageDetails",
+"description": "Required. Immutable. Total storage details for the ExadbVmCluster."
 }
 },
 "type": "object"
 },
-"DbSystemShape": {
-"description": "Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/",
-"id": "DbSystemShape",
+"ExadbVmClusterStorageDetails": {
+"description": "The storage allocation for the exadbvmcluster, in gigabytes (GB).",
+"id": "ExadbVmClusterStorageDetails",
 "properties": {
-"availableCoreCountPerNode": {
-"description": "Optional. Number of cores per node.",
-"format": "int32",
-"type": "integer"
-},
-"availableDataStorageTb": {
-"description": "Optional. Storage per storage server in terabytes.",
-"format": "int32",
-"type": "integer"
-},
-"availableMemoryPerNodeGb": {
-"description": "Optional. Memory per database server node in gigabytes.",
+"sizeInGbsPerNode": {
+"description": "Required. The storage allocation for the exadbvmcluster per node, in gigabytes (GB). This field is used to calculate the total storage allocation for the exadbvmcluster.",
 "format": "int32",
 "type": "integer"
+}
 },
-"maxNodeCount": {
-"description": "Optional. Maximum number of database servers.",
-"format": "int32",
-"type": "integer"
+"type": "object"
 },
-"maxStorageCount": {
-"description": "Optional. Maximum number of storage servers.",
+"ExascaleDbStorageDetails": {
+"description": "The storage details of the ExascaleDbStorageVault.",
+"id": "ExascaleDbStorageDetails",
+"properties": {
+"availableSizeGbs": {
+"description": "Output only. The available storage capacity for the ExascaleDbStorageVault, in gigabytes (GB).",
 "format": "int32",
+"readOnly": true,
 "type": "integer"
 },
-"minCoreCountPerNode": {
-"description": "Optional. Minimum core count per node.",
+"totalSizeGbs": {
+"description": "Required. The total storage allocation for the ExascaleDbStorageVault, in gigabytes (GB).",
 "format": "int32",
 "type": "integer"
+}
 },
-"minDbNodeStoragePerNodeGb": {
-"description": "Optional. Minimum node storage per database server in gigabytes.",
-"format": "int32",
-"type": "integer"
+"type": "object"
 },
-"minMemoryPerNodeGb": {
-"description": "Optional. Minimum memory per node in gigabytes.",
-"format": "int32",
-"type": "integer"
+"ExascaleDbStorageVault": {
+"description": "ExascaleDbStorageVault represents a storage vault exadb vm cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/ExascaleDbStorageVault/",
+"id": "ExascaleDbStorageVault",
+"properties": {
+"createTime": {
+"description": "Output only. The date and time when the ExascaleDbStorageVault was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
 },
-"minNodeCount": {
-"description": "Optional. Minimum number of database servers.",
-"format": "int32",
-"type": "integer"
+"displayName": {
+"description": "Required. The display name for the ExascaleDbStorageVault. The name does not have to be unique within your project. The name must be 1-255 characters long and can only contain alphanumeric characters.",
+"type": "string"
 },
-"minStorageCount": {
-"description": "Optional. Minimum number of storage servers.",
-"format": "int32",
-"type": "integer"
+"entitlementId": {
+"description": "Output only. The ID of the subscription entitlement associated with the ExascaleDbStorageVault.",
+"readOnly": true,
+"type": "string"
 },
-"name": {
-"description": "Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape}",
+"gcpOracleZone": {
+"description": "Optional. The GCP Oracle zone where Oracle ExascaleDbStorageVault is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.",
 "type": "string"
 },
-"shape": {
-"description": "Optional. shape",
+"labels": {
+"additionalProperties": {
 "type": "string"
-}
 },
+"description": "Optional. The labels or tags associated with the ExascaleDbStorageVault.",
 "type": "object"
 },
-"DbVersion": {
-"description": "A valid Oracle Database version.",
-"id": "DbVersion",
-"properties": {
 "name": {
-"description": "Output only. The name of the DbVersion resource in the following format: projects/{project}/locations/{region}/dbVersions/{db_version}",
-"readOnly": true,
+"description": "Identifier. The resource name of the ExascaleDbStorageVault. Format: projects/{project}/locations/{location}/exascaleDbStorageVaults/{exascale_db_storage_vault}",
 "type": "string"
 },
 "properties": {
-"$ref": "DbVersionProperties",
-"description": "Output only. The properties of the DbVersion.",
-"readOnly": true
+"$ref": "ExascaleDbStorageVaultProperties",
+"description": "Required. The properties of the ExascaleDbStorageVault."
 }
 },
 "type": "object"
 },
-"DbVersionProperties": {
-"description": "The properties of a DbVersion.",
-"id": "DbVersionProperties",
+"ExascaleDbStorageVaultProperties": {
+"description": "The properties of the ExascaleDbStorageVault. next ID: 12",
+"id": "ExascaleDbStorageVaultProperties",
 "properties": {
-"isLatestForMajorVersion": {
-"description": "Output only. True if this version of the Oracle Database software is the latest version for a release.",
-"readOnly": true,
-"type": "boolean"
-},
-"isPreviewDbVersion": {
-"description": "Output only. True if this version of the Oracle Database software is the preview version.",
-"readOnly": true,
-"type": "boolean"
+"additionalFlashCachePercent": {
+"description": "Optional. The size of additional flash cache in percentage of high capacity database storage.",
+"format": "int32",
+"type": "integer"
 },
-"isUpgradeSupported": {
-"description": "Output only. True if this version of the Oracle Database software is supported for Upgrade.",
-"readOnly": true,
-"type": "boolean"
+"attachedShapeAttributes": {
+"description": "Output only. The shape attributes of the VM clusters attached to the ExascaleDbStorageVault.",
+"items": {
+"enum": [
+"SHAPE_ATTRIBUTE_UNSPECIFIED",
+"SMART_STORAGE",
+"BLOCK_STORAGE"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"Indicates that the resource is in smart storage.",
+"Indicates that the resource is in block storage."
+],
+"type": "string"
 },
-"supportsPdb": {
-"description": "Output only. True if this version of the Oracle Database software supports pluggable databases.",
 "readOnly": true,
-"type": "boolean"
+"type": "array"
 },
-"version": {
-"description": "Output only. A valid Oracle Database version.",
-"readOnly": true,
+"availableShapeAttributes": {
+"description": "Output only. The shape attributes available for the VM clusters to be attached to the ExascaleDbStorageVault.",
+"items": {
+"enum": [
+"SHAPE_ATTRIBUTE_UNSPECIFIED",
+"SMART_STORAGE",
+"BLOCK_STORAGE"
+],
+"enumDescriptions": [
+"Default unspecified value.",
+"Indicates that the resource is in smart storage.",
+"Indicates that the resource is in block storage."
+],
 "type": "string"
-}
 },
-"type": "object"
+"readOnly": true,
+"type": "array"
 },
-"DefinedTagValue": {
-"description": "Wrapper message for the value of a defined tag.",
-"id": "DefinedTagValue",
-"properties": {
-"tags": {
-"additionalProperties": {
+"description": {
+"description": "Optional. The description of the ExascaleDbStorageVault.",
 "type": "string"
 },
-"description": "The tags within the namespace.",
-"type": "object"
-}
-},
-"type": "object"
-},
-"Empty": {
-"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
-"id": "Empty",
-"properties": {},
-"type": "object"
-},
-"Entitlement": {
-"description": "Details of the Entitlement resource.",
-"id": "Entitlement",
-"properties": {
-"cloudAccountDetails": {
-"$ref": "CloudAccountDetails",
-"description": "Details of the OCI Cloud Account."
+"exascaleDbStorageDetails": {
+"$ref": "ExascaleDbStorageDetails",
+"description": "Required. The storage details of the ExascaleDbStorageVault."
 },
-"entitlementId": {
-"description": "Output only. Google Cloud Marketplace order ID (aka entitlement ID)",
+"ociUri": {
+"description": "Output only. Deep link to the OCI console to view this resource.",
 "readOnly": true,
 "type": "string"
 },
-"name": {
-"description": "Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement}",
+"ocid": {
+"description": "Output only. The OCID for the ExascaleDbStorageVault.",
+"readOnly": true,
 "type": "string"
 },
 "state": {
-"description": "Output only. Entitlement State.",
+"description": "Output only. The state of the ExascaleDbStorageVault.",
 "enum": [
 "STATE_UNSPECIFIED",
-"ACCOUNT_NOT_LINKED",
-"ACCOUNT_NOT_ACTIVE",
-"ACTIVE",
-"ACCOUNT_SUSPENDED",
-"NOT_APPROVED_IN_PRIVATE_MARKETPLACE"
+"PROVISIONING",
+"AVAILABLE",
+"UPDATING",
+"TERMINATING",
+"TERMINATED",
+"FAILED"
 ],
 "enumDescriptions": [
-"Default unspecified value.",
-"Account not linked.",
-"Account is linked but not active.",
-"Entitlement and Account are active.",
-"Account is suspended.",
-"Entitlement is not approved in private marketplace."
+"The state of the ExascaleDbStorageVault is unspecified.",
+"The ExascaleDbStorageVault is being provisioned.",
+"The ExascaleDbStorageVault is available.",
+"The ExascaleDbStorageVault is being updated.",
+"The ExascaleDbStorageVault is being deleted.",
+"The ExascaleDbStorageVault has been deleted.",
+"The ExascaleDbStorageVault has failed."
 ],
 "readOnly": true,
 "type": "string"
+},
+"timeZone": {
+"$ref": "TimeZone",
+"description": "Output only. The time zone of the ExascaleDbStorageVault.",
+"readOnly": true
+},
+"vmClusterCount": {
+"description": "Output only. The number of VM clusters associated with the ExascaleDbStorageVault.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"vmClusterIds": {
+"description": "Output only. The list of VM cluster OCIDs associated with the ExascaleDbStorageVault.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+}
+},
+"type": "object"
+},
+"FailoverAutonomousDatabaseRequest": {
+"description": "The request for `OracleDatabase.FailoverAutonomousDatabase`.",
+"id": "FailoverAutonomousDatabaseRequest",
+"properties": {
+"peerAutonomousDatabase": {
+"description": "Required. The peer database name to fail over to.",
+"type": "string"
 }
 },
 "type": "object"
@@ -5170,6 +5997,42 @@
 },
 "type": "object"
 },
+"ListExadbVmClustersResponse": {
+"description": "The response for `ExadbVmCluster.List`.",
+"id": "ListExadbVmClustersResponse",
+"properties": {
+"exadbVmClusters": {
+"description": "The list of ExadbVmClusters.",
+"items": {
+"$ref": "ExadbVmCluster"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token identifying a page of results the server should return.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"ListExascaleDbStorageVaultsResponse": {
+"description": "The response for `ExascaleDbStorageVault.List`.",
+"id": "ListExascaleDbStorageVaultsResponse",
+"properties": {
+"exascaleDbStorageVaults": {
+"description": "The ExascaleDbStorageVaults.",
+"items": {
+"$ref": "ExascaleDbStorageVault"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token identifying a page of results the server should return. If present, the next page token can be provided to a subsequent ListExascaleDbStorageVaults call to list the next page. If empty, there are no more pages.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "ListGiVersionsResponse": {
 "description": "The response for `GiVersion.List`.",
 "id": "ListGiVersionsResponse",
@@ -5206,6 +6069,24 @@
 },
 "type": "object"
 },
+"ListMinorVersionsResponse": {
+"description": "The response for `MinorVersion.List`.",
+"id": "ListMinorVersionsResponse",
+"properties": {
+"minorVersions": {
+"description": "The list of MinorVersions.",
+"items": {
+"$ref": "MinorVersion"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token identifying a page of results the server should return.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "ListOdbNetworksResponse": {
 "description": "The response for `OdbNetwork.List`.",
 "id": "ListOdbNetworksResponse",
@@ -5470,6 +6351,25 @@
 },
 "type": "object"
 },
+"MinorVersion": {
+"description": "MinorVersion represents a minor version of a GI. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiMinorVersionSummary/",
+"id": "MinorVersion",
+"properties": {
+"gridImageId": {
+"description": "Optional. The ID of the Grid Image.",
+"type": "string"
+},
+"name": {
+"description": "Identifier. The name of the MinorVersion resource with the format: projects/{project}/locations/{region}/giVersions/{gi_version}/minorVersions/{minor_version}",
+"type": "string"
+},
+"version": {
+"description": "Optional. The valid Oracle grid infrastructure software version.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "OdbNetwork": {
 "description": "Represents OdbNetwork resource.",
 "id": "OdbNetwork",
@@ -5876,6 +6776,24 @@
 },
 "type": "object"
 },
+"RemoveVirtualMachineExadbVmClusterRequest": {
+"description": "The request for `ExadbVmCluster.RemoveVirtualMachine`.",
+"id": "RemoveVirtualMachineExadbVmClusterRequest",
+"properties": {
+"hostnames": {
+"description": "Required. The list of host names of db nodes to be removed from the ExadbVmCluster.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"requestId": {
+"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "RestartAutonomousDatabaseRequest": {
 "description": "The request for `AutonomousDatabase.Restart`.",
 "id": "RestartAutonomousDatabaseRequest",

From 7f362b739c62e66080ba7a5765972865a20064a9 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:09 +0000
Subject: [PATCH 23/26] feat(retail): update the api

#### retail:v2

The following keys were added:
- resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch (Total Keys: 12)
- resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch (Total Keys: 12)
- schemas.GoogleCloudRetailV2ConversationalSearchRequest (Total Keys: 34)
- schemas.GoogleCloudRetailV2ConversationalSearchResponse (Total Keys: 30)
- schemas.GoogleCloudRetailV2SafetySetting (Total Keys: 5)

#### retail:v2beta

The following keys were added:
- resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch (Total Keys: 12)
- resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch (Total Keys: 12)
- schemas.GoogleCloudRetailV2betaConversationalSearchRequest (Total Keys: 34)
- schemas.GoogleCloudRetailV2betaConversationalSearchResponse (Total Keys: 30)
- schemas.GoogleCloudRetailV2betaSafetySetting (Total Keys: 5)
---
 ...rojects.locations.catalogs.placements.html | 118 ++++++
 ...cts.locations.catalogs.servingConfigs.html | 118 ++++++
 ...rojects.locations.catalogs.placements.html |   2 +-
 ...cts.locations.catalogs.servingConfigs.html |   2 +-
 ...rojects.locations.catalogs.placements.html | 118 ++++++
 ...cts.locations.catalogs.servingConfigs.html | 118 ++++++
 .../discovery_cache/documents/retail.v2.json  | 374 +++++++++++++++++-
 .../documents/retail.v2alpha.json             |   4 +-
 .../documents/retail.v2beta.json              | 374 +++++++++++++++++-
 9 files changed, 1222 insertions(+), 6 deletions(-)

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html
index 17e8a6db2da..16380edae87 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html
@@ -77,6 +77,9 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  conversationalSearch(placement, body=None, x__xgafv=None)

+
Performs a conversational search. This feature is only available for users who have Conversational Search enabled.

 

   predict(placement, body=None, x__xgafv=None)

 
Makes a recommendation prediction.

@@ -92,6 +95,121 @@ 
Method Details

   
Close httplib2 connections.
+
+ conversationalSearch(placement, body=None, x__xgafv=None) + 
Performs a conversational search. This feature is only available for users who have Conversational Search enabled.
+
+Args:
+  placement: string, Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversationalSearchService.ConversationalSearch method.
+  "branch": "A String", # Required. The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
+  "conversationId": "A String", # Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.
+  "conversationalFilteringSpec": { # This field specifies all conversational filtering related parameters addition to conversational retail search. # Optional. This field specifies all conversational filtering related parameters.
+    "conversationalFilteringMode": "A String", # Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.
+    "enableConversationalFiltering": True or False, # Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.
+    "userAnswer": { # This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text. # Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text.
+      "selectedAnswer": { # This field specifies the selected answers during the conversational search. # Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers.
+        "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Optional. This field specifies the selected answer which is a attribute key-value.
+          "name": "A String", # The attribute name.
+          "value": "A String", # The attribute value.
+        },
+      },
+      "textAnswer": "A String", # This field specifies the incremental input text from the user during the conversational search.
+    },
+  },
+  "pageCategories": [ # Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
+    "A String",
+  ],
+  "query": "A String", # Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.
+  "safetySettings": [ # Optional. The safety settings to be applied to the generated content.
+    { # Safety settings.
+      "category": "A String", # Harm category.
+      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
+      "threshold": "A String", # The harm block threshold.
+    },
+  ],
+  "searchParams": { # Search parameters. # Optional. Search parameters.
+    "boostSpec": { # Boost specification to boost certain items. # Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec.
+      "conditionBoostSpecs": [ # Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+        { # Boost applies to products which match a condition.
+          "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+          "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": * (id: ANY("product_1", "product_2")) AND (colorFamilies: ANY("Red","Blue"))
+        },
+      ],
+      "skipBoostSpecValidation": True or False, # Whether to skip boostspec validation. If this field is set to true, invalid BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.condition_boost_specs will still be applied.
+    },
+    "canonicalFilter": "A String", # Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.
+    "filter": "A String", # Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter.
+    "sortBy": "A String", # Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort.
+  },
+  "userInfo": { # Information of an end user. # Optional. User information.
+    "directUserRequest": True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
+    "ipAddress": "A String", # The end user's IP address. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when: * setting SearchRequest.user_info. * using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
+    "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
+    "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  },
+  "userLabels": { # Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+    "a_key": "A String",
+  },
+  "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConversationalSearchService.ConversationalSearch method.
+  "conversationId": "A String", # Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.
+  "conversationalFilteringResult": { # This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. # This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
+    "additionalFilter": { # Additional filter that client side need to apply. # This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests.
+      "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+        "name": "A String", # The attribute name.
+        "value": "A String", # The attribute value.
+      },
+    },
+    "followupQuestion": { # The conversational followup question generated for Intent refinement. # The conversational filtering question.
+      "followupQuestion": "A String", # The conversational followup question generated for Intent refinement.
+      "suggestedAnswers": [ # The answer options provided to client for the follow-up question.
+        { # Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.
+          "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+            "name": "A String", # The attribute name.
+            "value": "A String", # The attribute value.
+          },
+        },
+      ],
+    },
+  },
+  "conversationalTextResponse": "A String", # The conversational answer-based text response generated by the Server.
+  "followupQuestion": { # The conversational followup question generated for Intent refinement. # The conversational followup question generated for Intent refinement.
+    "followupQuestion": "A String", # The conversational followup question generated for Intent refinement.
+    "suggestedAnswers": [ # The answer options provided to client for the follow-up question.
+      { # Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.
+        "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+          "name": "A String", # The attribute name.
+          "value": "A String", # The attribute value.
+        },
+      },
+    ],
+  },
+  "refinedSearch": [ # The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.
+    { # The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.
+      "query": "A String", # The query to be used for search.
+    },
+  ],
+  "state": "A String", # Output only. The state of the response generation.
+  "userQueryTypes": [ # The types Retail classifies the search query as. Supported values are: - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED"
+    "A String",
+  ],
+}
+
+
predict(placement, body=None, x__xgafv=None) 
Makes a recommendation prediction.
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
index 5a4f196d72e..0c8213a3a56 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
@@ -80,6 +80,9 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  conversationalSearch(placement, body=None, x__xgafv=None)

+
Performs a conversational search. This feature is only available for users who have Conversational Search enabled.

 

   create(parent, body=None, servingConfigId=None, x__xgafv=None)

 
Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.

@@ -185,6 +188,121 @@ 
Method Details

   
Close httplib2 connections.
+
+ conversationalSearch(placement, body=None, x__xgafv=None) + 
Performs a conversational search. This feature is only available for users who have Conversational Search enabled.
+
+Args:
+  placement: string, Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversationalSearchService.ConversationalSearch method.
+  "branch": "A String", # Required. The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
+  "conversationId": "A String", # Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.
+  "conversationalFilteringSpec": { # This field specifies all conversational filtering related parameters addition to conversational retail search. # Optional. This field specifies all conversational filtering related parameters.
+    "conversationalFilteringMode": "A String", # Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.
+    "enableConversationalFiltering": True or False, # Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.
+    "userAnswer": { # This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text. # Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text.
+      "selectedAnswer": { # This field specifies the selected answers during the conversational search. # Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers.
+        "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Optional. This field specifies the selected answer which is a attribute key-value.
+          "name": "A String", # The attribute name.
+          "value": "A String", # The attribute value.
+        },
+      },
+      "textAnswer": "A String", # This field specifies the incremental input text from the user during the conversational search.
+    },
+  },
+  "pageCategories": [ # Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
+    "A String",
+  ],
+  "query": "A String", # Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.
+  "safetySettings": [ # Optional. The safety settings to be applied to the generated content.
+    { # Safety settings.
+      "category": "A String", # Harm category.
+      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
+      "threshold": "A String", # The harm block threshold.
+    },
+  ],
+  "searchParams": { # Search parameters. # Optional. Search parameters.
+    "boostSpec": { # Boost specification to boost certain items. # Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec.
+      "conditionBoostSpecs": [ # Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+        { # Boost applies to products which match a condition.
+          "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+          "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": * (id: ANY("product_1", "product_2")) AND (colorFamilies: ANY("Red","Blue"))
+        },
+      ],
+      "skipBoostSpecValidation": True or False, # Whether to skip boostspec validation. If this field is set to true, invalid BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.condition_boost_specs will still be applied.
+    },
+    "canonicalFilter": "A String", # Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.
+    "filter": "A String", # Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter.
+    "sortBy": "A String", # Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort.
+  },
+  "userInfo": { # Information of an end user. # Optional. User information.
+    "directUserRequest": True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
+    "ipAddress": "A String", # The end user's IP address. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when: * setting SearchRequest.user_info. * using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
+    "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
+    "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  },
+  "userLabels": { # Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+    "a_key": "A String",
+  },
+  "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConversationalSearchService.ConversationalSearch method.
+  "conversationId": "A String", # Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.
+  "conversationalFilteringResult": { # This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. # This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
+    "additionalFilter": { # Additional filter that client side need to apply. # This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests.
+      "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+        "name": "A String", # The attribute name.
+        "value": "A String", # The attribute value.
+      },
+    },
+    "followupQuestion": { # The conversational followup question generated for Intent refinement. # The conversational filtering question.
+      "followupQuestion": "A String", # The conversational followup question generated for Intent refinement.
+      "suggestedAnswers": [ # The answer options provided to client for the follow-up question.
+        { # Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.
+          "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+            "name": "A String", # The attribute name.
+            "value": "A String", # The attribute value.
+          },
+        },
+      ],
+    },
+  },
+  "conversationalTextResponse": "A String", # The conversational answer-based text response generated by the Server.
+  "followupQuestion": { # The conversational followup question generated for Intent refinement. # The conversational followup question generated for Intent refinement.
+    "followupQuestion": "A String", # The conversational followup question generated for Intent refinement.
+    "suggestedAnswers": [ # The answer options provided to client for the follow-up question.
+      { # Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.
+        "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+          "name": "A String", # The attribute name.
+          "value": "A String", # The attribute value.
+        },
+      },
+    ],
+  },
+  "refinedSearch": [ # The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.
+    { # The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.
+      "query": "A String", # The query to be used for search.
+    },
+  ],
+  "state": "A String", # Output only. The state of the response generation.
+  "userQueryTypes": [ # The types Retail classifies the search query as. Supported values are: - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED"
+    "A String",
+  ],
+}
+
+
create(parent, body=None, servingConfigId=None, x__xgafv=None) 
Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
index 1827d3a9a8e..2da83c55f3e 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
@@ -204,7 +204,7 @@ 
Method Details

     },
   ],
   "state": "A String", # Output only. The state of the response generation.
-  "userQueryTypes": [ # LINT.IfChange(query_types_proto) The types Retail classifies the search query as. Supported values are: - "ADVERSARIAL" - "CHITCHAT" - "JAILBREAK" - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED" LINT.ThenChange(//depot/google3/cloud/console/web/ai/retail/service/conversational_search_customization_config.ts:intent_types_ts)
+  "userQueryTypes": [ # The types Retail classifies the search query as. Supported values are: - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED"
     "A String",
   ],
 }
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html index 3e3d3f1a5af..c43843c4a0a 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html @@ -297,7 +297,7 @@

Method Details

}, ], "state": "A String", # Output only. The state of the response generation. - "userQueryTypes": [ # LINT.IfChange(query_types_proto) The types Retail classifies the search query as. Supported values are: - "ADVERSARIAL" - "CHITCHAT" - "JAILBREAK" - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED" LINT.ThenChange(//depot/google3/cloud/console/web/ai/retail/service/conversational_search_customization_config.ts:intent_types_ts) + "userQueryTypes": [ # The types Retail classifies the search query as. Supported values are: - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED" "A String", ], } diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html index 733cfff0e3b..c0dd0a6068d 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ conversationalSearch(placement, body=None, x__xgafv=None)

+

Performs a conversational search. This feature is only available for users who have Conversational Search enabled.

predict(placement, body=None, x__xgafv=None)

Makes a recommendation prediction.

@@ -92,6 +95,121 @@

Method Details

Close httplib2 connections.
+
+ conversationalSearch(placement, body=None, x__xgafv=None) + 
Performs a conversational search. This feature is only available for users who have Conversational Search enabled.
+
+Args:
+  placement: string, Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversationalSearchService.ConversationalSearch method.
+  "branch": "A String", # Required. The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
+  "conversationId": "A String", # Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.
+  "conversationalFilteringSpec": { # This field specifies all conversational filtering related parameters addition to conversational retail search. # Optional. This field specifies all conversational filtering related parameters.
+    "conversationalFilteringMode": "A String", # Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.
+    "enableConversationalFiltering": True or False, # Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.
+    "userAnswer": { # This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text. # Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text.
+      "selectedAnswer": { # This field specifies the selected answers during the conversational search. # Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers.
+        "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Optional. This field specifies the selected answer which is a attribute key-value.
+          "name": "A String", # The attribute name.
+          "value": "A String", # The attribute value.
+        },
+      },
+      "textAnswer": "A String", # This field specifies the incremental input text from the user during the conversational search.
+    },
+  },
+  "pageCategories": [ # Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
+    "A String",
+  ],
+  "query": "A String", # Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.
+  "safetySettings": [ # Optional. The safety settings to be applied to the generated content.
+    { # Safety settings.
+      "category": "A String", # Harm category.
+      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
+      "threshold": "A String", # The harm block threshold.
+    },
+  ],
+  "searchParams": { # Search parameters. # Optional. Search parameters.
+    "boostSpec": { # Boost specification to boost certain items. # Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec.
+      "conditionBoostSpecs": [ # Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+        { # Boost applies to products which match a condition.
+          "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+          "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": * (id: ANY("product_1", "product_2")) AND (colorFamilies: ANY("Red","Blue"))
+        },
+      ],
+      "skipBoostSpecValidation": True or False, # Whether to skip boostspec validation. If this field is set to true, invalid BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.condition_boost_specs will still be applied.
+    },
+    "canonicalFilter": "A String", # Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.
+    "filter": "A String", # Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter.
+    "sortBy": "A String", # Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort.
+  },
+  "userInfo": { # Information of an end user. # Optional. User information.
+    "directUserRequest": True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
+    "ipAddress": "A String", # The end user's IP address. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when: * setting SearchRequest.user_info. * using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
+    "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
+    "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  },
+  "userLabels": { # Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+    "a_key": "A String",
+  },
+  "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConversationalSearchService.ConversationalSearch method.
+  "conversationId": "A String", # Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.
+  "conversationalFilteringResult": { # This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. # This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
+    "additionalFilter": { # Additional filter that client side need to apply. # This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests.
+      "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+        "name": "A String", # The attribute name.
+        "value": "A String", # The attribute value.
+      },
+    },
+    "followupQuestion": { # The conversational followup question generated for Intent refinement. # The conversational filtering question.
+      "followupQuestion": "A String", # The conversational followup question generated for Intent refinement.
+      "suggestedAnswers": [ # The answer options provided to client for the follow-up question.
+        { # Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.
+          "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+            "name": "A String", # The attribute name.
+            "value": "A String", # The attribute value.
+          },
+        },
+      ],
+    },
+  },
+  "conversationalTextResponse": "A String", # The conversational answer-based text response generated by the Server.
+  "followupQuestion": { # The conversational followup question generated for Intent refinement. # The conversational followup question generated for Intent refinement.
+    "followupQuestion": "A String", # The conversational followup question generated for Intent refinement.
+    "suggestedAnswers": [ # The answer options provided to client for the follow-up question.
+      { # Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.
+        "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+          "name": "A String", # The attribute name.
+          "value": "A String", # The attribute value.
+        },
+      },
+    ],
+  },
+  "refinedSearch": [ # The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.
+    { # The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.
+      "query": "A String", # The query to be used for search.
+    },
+  ],
+  "state": "A String", # Output only. The state of the response generation.
+  "userQueryTypes": [ # The types Retail classifies the search query as. Supported values are: - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED"
+    "A String",
+  ],
+}
+
+
predict(placement, body=None, x__xgafv=None) 
Makes a recommendation prediction.
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html
index 3484f08ac4f..c6177acd10d 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html
@@ -80,6 +80,9 @@ 
Instance Methods

 

   close()

 
Close httplib2 connections.

+

+  conversationalSearch(placement, body=None, x__xgafv=None)

+
Performs a conversational search. This feature is only available for users who have Conversational Search enabled.

 

   create(parent, body=None, servingConfigId=None, x__xgafv=None)

 
Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.

@@ -185,6 +188,121 @@ 
Method Details

   
Close httplib2 connections.
+
+ conversationalSearch(placement, body=None, x__xgafv=None) + 
Performs a conversational search. This feature is only available for users who have Conversational Search enabled.
+
+Args:
+  placement: string, Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ConversationalSearchService.ConversationalSearch method.
+  "branch": "A String", # Required. The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
+  "conversationId": "A String", # Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.
+  "conversationalFilteringSpec": { # This field specifies all conversational filtering related parameters addition to conversational retail search. # Optional. This field specifies all conversational filtering related parameters.
+    "conversationalFilteringMode": "A String", # Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.
+    "enableConversationalFiltering": True or False, # Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.
+    "userAnswer": { # This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text. # Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text.
+      "selectedAnswer": { # This field specifies the selected answers during the conversational search. # Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers.
+        "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Optional. This field specifies the selected answer which is a attribute key-value.
+          "name": "A String", # The attribute name.
+          "value": "A String", # The attribute value.
+        },
+      },
+      "textAnswer": "A String", # This field specifies the incremental input text from the user during the conversational search.
+    },
+  },
+  "pageCategories": [ # Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
+    "A String",
+  ],
+  "query": "A String", # Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.
+  "safetySettings": [ # Optional. The safety settings to be applied to the generated content.
+    { # Safety settings.
+      "category": "A String", # Harm category.
+      "method": "A String", # Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
+      "threshold": "A String", # The harm block threshold.
+    },
+  ],
+  "searchParams": { # Search parameters. # Optional. Search parameters.
+    "boostSpec": { # Boost specification to boost certain items. # Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec.
+      "conditionBoostSpecs": [ # Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+        { # Boost applies to products which match a condition.
+          "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the item a big promotion. However, it does not necessarily mean that the boosted item will be the top result at all times, nor that other items will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant items. Setting to -1.0 gives the item a big demotion. However, results that are deeply relevant might still be shown. The item will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
+          "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost products with product ID "product_1" or "product_2", and color "Red" or "Blue": * (id: ANY("product_1", "product_2")) AND (colorFamilies: ANY("Red","Blue"))
+        },
+      ],
+      "skipBoostSpecValidation": True or False, # Whether to skip boostspec validation. If this field is set to true, invalid BoostSpec.condition_boost_specs will be ignored and valid BoostSpec.condition_boost_specs will still be applied.
+    },
+    "canonicalFilter": "A String", # Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.
+    "filter": "A String", # Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter.
+    "sortBy": "A String", # Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort.
+  },
+  "userInfo": { # Information of an end user. # Optional. User information.
+    "directUserRequest": True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
+    "ipAddress": "A String", # The end user's IP address. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when: * setting SearchRequest.user_info. * using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
+    "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.
+    "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  },
+  "userLabels": { # Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+    "a_key": "A String",
+  },
+  "visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ConversationalSearchService.ConversationalSearch method.
+  "conversationId": "A String", # Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.
+  "conversationalFilteringResult": { # This field specifies all related information that is needed on client side for UI rendering of conversational filtering search. # This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.
+    "additionalFilter": { # Additional filter that client side need to apply. # This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests.
+      "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+        "name": "A String", # The attribute name.
+        "value": "A String", # The attribute value.
+      },
+    },
+    "followupQuestion": { # The conversational followup question generated for Intent refinement. # The conversational filtering question.
+      "followupQuestion": "A String", # The conversational followup question generated for Intent refinement.
+      "suggestedAnswers": [ # The answer options provided to client for the follow-up question.
+        { # Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.
+          "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+            "name": "A String", # The attribute name.
+            "value": "A String", # The attribute value.
+          },
+        },
+      ],
+    },
+  },
+  "conversationalTextResponse": "A String", # The conversational answer-based text response generated by the Server.
+  "followupQuestion": { # The conversational followup question generated for Intent refinement. # The conversational followup question generated for Intent refinement.
+    "followupQuestion": "A String", # The conversational followup question generated for Intent refinement.
+    "suggestedAnswers": [ # The answer options provided to client for the follow-up question.
+      { # Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.
+        "productAttributeValue": { # Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. # Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future.
+          "name": "A String", # The attribute name.
+          "value": "A String", # The attribute value.
+        },
+      },
+    ],
+  },
+  "refinedSearch": [ # The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.
+    { # The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.
+      "query": "A String", # The query to be used for search.
+    },
+  ],
+  "state": "A String", # Output only. The state of the response generation.
+  "userQueryTypes": [ # The types Retail classifies the search query as. Supported values are: - "ORDER_SUPPORT" - "SIMPLE_PRODUCT_SEARCH" - "INTENT_REFINEMENT" - "PRODUCT_DETAILS" - "PRODUCT_COMPARISON" - "DEALS_AND_COUPONS" - "STORE_RELEVANT" - "BLOCKLISTED" - "BEST_PRODUCT" - "RETAIL_SUPPORT" - "DISABLED"
+    "A String",
+  ],
+}
+
+
create(parent, body=None, servingConfigId=None, x__xgafv=None) 
Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.
diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json
index d04b4479068..d83f6b8d46c 100644
--- a/googleapiclient/discovery_cache/documents/retail.v2.json
+++ b/googleapiclient/discovery_cache/documents/retail.v2.json
@@ -1659,6 +1659,34 @@
 },
 "placements": {
 "methods": {
+"conversationalSearch": {
+"description": "Performs a conversational search. This feature is only available for users who have Conversational Search enabled.",
+"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:conversationalSearch",
+"httpMethod": "POST",
+"id": "retail.projects.locations.catalogs.placements.conversationalSearch",
+"parameterOrder": [
+"placement"
+],
+"parameters": {
+"placement": {
+"description": "Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/placements/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+placement}:conversationalSearch",
+"request": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchRequest"
+},
+"response": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "predict": {
 "description": "Makes a recommendation prediction.",
 "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:predict",
@@ -1747,6 +1775,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"conversationalSearch": {
+"description": "Performs a conversational search. This feature is only available for users who have Conversational Search enabled.",
+"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:conversationalSearch",
+"httpMethod": "POST",
+"id": "retail.projects.locations.catalogs.servingConfigs.conversationalSearch",
+"parameterOrder": [
+"placement"
+],
+"parameters": {
+"placement": {
+"description": "Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+placement}:conversationalSearch",
+"request": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchRequest"
+},
+"response": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "create": {
 "description": "Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.",
 "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs",
@@ -2282,7 +2338,7 @@
 }
 }
 },
-"revision": "20250717",
+"revision": "20250911",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -3251,6 +3307,261 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2ConversationalSearchRequest": {
+"description": "Request message for ConversationalSearchService.ConversationalSearch method.",
+"id": "GoogleCloudRetailV2ConversationalSearchRequest",
+"properties": {
+"branch": {
+"description": "Required. The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use \"default_branch\" as the branch ID or leave this field empty, to search products under the default branch.",
+"type": "string"
+},
+"conversationId": {
+"description": "Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.",
+"type": "string"
+},
+"conversationalFilteringSpec": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec",
+"description": "Optional. This field specifies all conversational filtering related parameters."
+},
+"pageCategories": {
+"description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: \"pageCategories\" : [\"Sales > 2017 Black Friday Deals\"].",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"query": {
+"description": "Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.",
+"type": "string"
+},
+"safetySettings": {
+"description": "Optional. The safety settings to be applied to the generated content.",
+"items": {
+"$ref": "GoogleCloudRetailV2SafetySetting"
+},
+"type": "array"
+},
+"searchParams": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchRequestSearchParams",
+"description": "Optional. Search parameters."
+},
+"userInfo": {
+"$ref": "GoogleCloudRetailV2UserInfo",
+"description": "Optional. User information."
+},
+"userLabels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
+"type": "object"
+},
+"visitorId": {
+"description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec": {
+"description": "This field specifies all conversational filtering related parameters addition to conversational retail search.",
+"id": "GoogleCloudRetailV2ConversationalSearchRequestConversationalFilteringSpec",
+"properties": {
+"conversationalFilteringMode": {
+"description": "Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.",
+"enum": [
+"MODE_UNSPECIFIED",
+"DISABLED",
+"ENABLED",
+"CONVERSATIONAL_FILTER_ONLY"
+],
+"enumDescriptions": [
+"Default value.",
+"Disables Conversational Filtering when using Conversational Search.",
+"Enables Conversational Filtering when using Conversational Search.",
+"Enables Conversational Filtering without Conversational Search."
+],
+"type": "string"
+},
+"enableConversationalFiltering": {
+"deprecated": true,
+"description": "Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.",
+"type": "boolean"
+},
+"userAnswer": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchRequestUserAnswer",
+"description": "Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ConversationalSearchRequestSearchParams": {
+"description": "Search parameters.",
+"id": "GoogleCloudRetailV2ConversationalSearchRequestSearchParams",
+"properties": {
+"boostSpec": {
+"$ref": "GoogleCloudRetailV2SearchRequestBoostSpec",
+"description": "Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec."
+},
+"canonicalFilter": {
+"description": "Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.",
+"type": "string"
+},
+"filter": {
+"description": "Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter.",
+"type": "string"
+},
+"sortBy": {
+"description": "Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ConversationalSearchRequestUserAnswer": {
+"description": "This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text.",
+"id": "GoogleCloudRetailV2ConversationalSearchRequestUserAnswer",
+"properties": {
+"selectedAnswer": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer",
+"description": "Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers."
+},
+"textAnswer": {
+"description": "This field specifies the incremental input text from the user during the conversational search.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer": {
+"description": "This field specifies the selected answers during the conversational search.",
+"id": "GoogleCloudRetailV2ConversationalSearchRequestUserAnswerSelectedAnswer",
+"properties": {
+"productAttributeValue": {
+"$ref": "GoogleCloudRetailV2ProductAttributeValue",
+"description": "Optional. This field specifies the selected answer which is a attribute key-value."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ConversationalSearchResponse": {
+"description": "Response message for ConversationalSearchService.ConversationalSearch method.",
+"id": "GoogleCloudRetailV2ConversationalSearchResponse",
+"properties": {
+"conversationId": {
+"description": "Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.",
+"type": "string"
+},
+"conversationalFilteringResult": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult",
+"description": "This field specifies all related information that is needed on client side for UI rendering of conversational filtering search."
+},
+"conversationalTextResponse": {
+"description": "The conversational answer-based text response generated by the Server.",
+"type": "string"
+},
+"followupQuestion": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion",
+"description": "The conversational followup question generated for Intent refinement."
+},
+"refinedSearch": {
+"description": "The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.",
+"items": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch"
+},
+"type": "array"
+},
+"state": {
+"description": "Output only. The state of the response generation.",
+"enum": [
+"STATE_UNSPECIFIED",
+"STREAMING",
+"SUCCEEDED"
+],
+"enumDescriptions": [
+"Unknown.",
+"Response generation is being streamed.",
+"Response generation has succeeded."
+],
+"readOnly": true,
+"type": "string"
+},
+"userQueryTypes": {
+"description": "The types Retail classifies the search query as. Supported values are: - \"ORDER_SUPPORT\" - \"SIMPLE_PRODUCT_SEARCH\" - \"INTENT_REFINEMENT\" - \"PRODUCT_DETAILS\" - \"PRODUCT_COMPARISON\" - \"DEALS_AND_COUPONS\" - \"STORE_RELEVANT\" - \"BLOCKLISTED\" - \"BEST_PRODUCT\" - \"RETAIL_SUPPORT\" - \"DISABLED\"",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult": {
+"description": "This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.",
+"id": "GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResult",
+"properties": {
+"additionalFilter": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter",
+"description": "This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests."
+},
+"followupQuestion": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion",
+"description": "The conversational filtering question."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter": {
+"description": "Additional filter that client side need to apply.",
+"id": "GoogleCloudRetailV2ConversationalSearchResponseConversationalFilteringResultAdditionalFilter",
+"properties": {
+"productAttributeValue": {
+"$ref": "GoogleCloudRetailV2ProductAttributeValue",
+"description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion": {
+"description": "The conversational followup question generated for Intent refinement.",
+"id": "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestion",
+"properties": {
+"followupQuestion": {
+"description": "The conversational followup question generated for Intent refinement.",
+"type": "string"
+},
+"suggestedAnswers": {
+"description": "The answer options provided to client for the follow-up question.",
+"items": {
+"$ref": "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer": {
+"description": "Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.",
+"id": "GoogleCloudRetailV2ConversationalSearchResponseFollowupQuestionSuggestedAnswer",
+"properties": {
+"productAttributeValue": {
+"$ref": "GoogleCloudRetailV2ProductAttributeValue",
+"description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch": {
+"description": "The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.",
+"id": "GoogleCloudRetailV2ConversationalSearchResponseRefinedSearch",
+"properties": {
+"query": {
+"description": "The query to be used for search.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2CreateModelMetadata": {
 "description": "Metadata associated with a create operation.",
 "id": "GoogleCloudRetailV2CreateModelMetadata",
@@ -5347,6 +5658,67 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2SafetySetting": {
+"description": "Safety settings.",
+"id": "GoogleCloudRetailV2SafetySetting",
+"properties": {
+"category": {
+"description": "Harm category.",
+"enum": [
+"HARM_CATEGORY_UNSPECIFIED",
+"HARM_CATEGORY_HATE_SPEECH",
+"HARM_CATEGORY_DANGEROUS_CONTENT",
+"HARM_CATEGORY_HARASSMENT",
+"HARM_CATEGORY_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_CIVIC_INTEGRITY"
+],
+"enumDescriptions": [
+"The harm category is unspecified.",
+"The harm category is hate speech.",
+"The harm category is dangerous content.",
+"The harm category is harassment.",
+"The harm category is sexually explicit content.",
+"The harm category is civic integrity."
+],
+"type": "string"
+},
+"method": {
+"description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.",
+"enum": [
+"HARM_BLOCK_METHOD_UNSPECIFIED",
+"SEVERITY",
+"PROBABILITY"
+],
+"enumDescriptions": [
+"The harm block method is unspecified.",
+"The harm block method uses both probability and severity scores.",
+"The harm block method uses the probability score."
+],
+"type": "string"
+},
+"threshold": {
+"description": "The harm block threshold.",
+"enum": [
+"HARM_BLOCK_THRESHOLD_UNSPECIFIED",
+"BLOCK_LOW_AND_ABOVE",
+"BLOCK_MEDIUM_AND_ABOVE",
+"BLOCK_ONLY_HIGH",
+"BLOCK_NONE",
+"OFF"
+],
+"enumDescriptions": [
+"Unspecified harm block threshold.",
+"Block low threshold and above (i.e. block more).",
+"Block medium threshold and above.",
+"Block only high threshold (i.e. block less).",
+"Block none.",
+"Turn off the safety filter."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2SearchRequest": {
 "description": "Request message for SearchService.Search method.",
 "id": "GoogleCloudRetailV2SearchRequest",
diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json
index aeeddf619cb..b4ce30b8659 100644
--- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json
+++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json
@@ -2859,7 +2859,7 @@
 }
 }
 },
-"revision": "20250828",
+"revision": "20250911",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -4810,7 +4810,7 @@
 "type": "string"
 },
 "userQueryTypes": {
-"description": "LINT.IfChange(query_types_proto) The types Retail classifies the search query as. Supported values are: - \"ADVERSARIAL\" - \"CHITCHAT\" - \"JAILBREAK\" - \"ORDER_SUPPORT\" - \"SIMPLE_PRODUCT_SEARCH\" - \"INTENT_REFINEMENT\" - \"PRODUCT_DETAILS\" - \"PRODUCT_COMPARISON\" - \"DEALS_AND_COUPONS\" - \"STORE_RELEVANT\" - \"BLOCKLISTED\" - \"BEST_PRODUCT\" - \"RETAIL_SUPPORT\" - \"DISABLED\" LINT.ThenChange(//depot/google3/cloud/console/web/ai/retail/service/conversational_search_customization_config.ts:intent_types_ts)",
+"description": "The types Retail classifies the search query as. Supported values are: - \"ORDER_SUPPORT\" - \"SIMPLE_PRODUCT_SEARCH\" - \"INTENT_REFINEMENT\" - \"PRODUCT_DETAILS\" - \"PRODUCT_COMPARISON\" - \"DEALS_AND_COUPONS\" - \"STORE_RELEVANT\" - \"BLOCKLISTED\" - \"BEST_PRODUCT\" - \"RETAIL_SUPPORT\" - \"DISABLED\"",
 "items": {
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json
index c05a70bd85c..6368afcaf88 100644
--- a/googleapiclient/discovery_cache/documents/retail.v2beta.json
+++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json
@@ -1776,6 +1776,34 @@
 },
 "placements": {
 "methods": {
+"conversationalSearch": {
+"description": "Performs a conversational search. This feature is only available for users who have Conversational Search enabled.",
+"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:conversationalSearch",
+"httpMethod": "POST",
+"id": "retail.projects.locations.catalogs.placements.conversationalSearch",
+"parameterOrder": [
+"placement"
+],
+"parameters": {
+"placement": {
+"description": "Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/placements/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2beta/{+placement}:conversationalSearch",
+"request": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchRequest"
+},
+"response": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "predict": {
 "description": "Makes a recommendation prediction.",
 "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/placements/{placementsId}:predict",
@@ -1864,6 +1892,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"conversationalSearch": {
+"description": "Performs a conversational search. This feature is only available for users who have Conversational Search enabled.",
+"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs/{servingConfigsId}:conversationalSearch",
+"httpMethod": "POST",
+"id": "retail.projects.locations.catalogs.servingConfigs.conversationalSearch",
+"parameterOrder": [
+"placement"
+],
+"parameters": {
+"placement": {
+"description": "Required. The resource name of the search engine placement, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search` or `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` This field is used to identify the serving config name and the set of models that will be used to make the search.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/servingConfigs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2beta/{+placement}:conversationalSearch",
+"request": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchRequest"
+},
+"response": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "create": {
 "description": "Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.",
 "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/servingConfigs",
@@ -2427,7 +2483,7 @@
 }
 }
 },
-"revision": "20250807",
+"revision": "20250911",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -4911,6 +4967,261 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2betaConversationalSearchRequest": {
+"description": "Request message for ConversationalSearchService.ConversationalSearch method.",
+"id": "GoogleCloudRetailV2betaConversationalSearchRequest",
+"properties": {
+"branch": {
+"description": "Required. The branch resource name, such as `projects/*/locations/global/catalogs/default_catalog/branches/0`. Use \"default_branch\" as the branch ID or leave this field empty, to search products under the default branch.",
+"type": "string"
+},
+"conversationId": {
+"description": "Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.",
+"type": "string"
+},
+"conversationalFilteringSpec": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec",
+"description": "Optional. This field specifies all conversational filtering related parameters."
+},
+"pageCategories": {
+"description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories; To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: \"pageCategories\" : [\"Sales > 2017 Black Friday Deals\"].",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"query": {
+"description": "Optional. Raw search query to be searched for. If this field is empty, the request is considered a category browsing request.",
+"type": "string"
+},
+"safetySettings": {
+"description": "Optional. The safety settings to be applied to the generated content.",
+"items": {
+"$ref": "GoogleCloudRetailV2betaSafetySetting"
+},
+"type": "array"
+},
+"searchParams": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchRequestSearchParams",
+"description": "Optional. Search parameters."
+},
+"userInfo": {
+"$ref": "GoogleCloudRetailV2betaUserInfo",
+"description": "Optional. User information."
+},
+"userLabels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Optional. The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
+"type": "object"
+},
+"visitorId": {
+"description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This should be the same identifier as UserEvent.visitor_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec": {
+"description": "This field specifies all conversational filtering related parameters addition to conversational retail search.",
+"id": "GoogleCloudRetailV2betaConversationalSearchRequestConversationalFilteringSpec",
+"properties": {
+"conversationalFilteringMode": {
+"description": "Optional. Mode to control Conversational Filtering. Defaults to Mode.DISABLED if it's unset.",
+"enum": [
+"MODE_UNSPECIFIED",
+"DISABLED",
+"ENABLED",
+"CONVERSATIONAL_FILTER_ONLY"
+],
+"enumDescriptions": [
+"Default value.",
+"Disables Conversational Filtering when using Conversational Search.",
+"Enables Conversational Filtering when using Conversational Search.",
+"Enables Conversational Filtering without Conversational Search."
+],
+"type": "string"
+},
+"enableConversationalFiltering": {
+"deprecated": true,
+"description": "Optional. This field is deprecated. Please use ConversationalFilteringSpec.conversational_filtering_mode instead.",
+"type": "boolean"
+},
+"userAnswer": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer",
+"description": "Optional. This field specifies the current user answer during the conversational filtering search. It can be either user selected from suggested answers or user input plain text."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaConversationalSearchRequestSearchParams": {
+"description": "Search parameters.",
+"id": "GoogleCloudRetailV2betaConversationalSearchRequestSearchParams",
+"properties": {
+"boostSpec": {
+"$ref": "GoogleCloudRetailV2betaSearchRequestBoostSpec",
+"description": "Optional. The boost spec to specify the boosting of search results. The syntax of the boost spec is the same as SearchRequest.boost_spec."
+},
+"canonicalFilter": {
+"description": "Optional. The canonical filter string to restrict search results. The syntax of the canonical filter string is the same as SearchRequest.canonical_filter.",
+"type": "string"
+},
+"filter": {
+"description": "Optional. The filter string to restrict search results. The syntax of the filter string is the same as SearchRequest.filter.",
+"type": "string"
+},
+"sortBy": {
+"description": "Optional. The sort string to specify the sorting of search results. The syntax of the sort string is the same as SearchRequest.sort.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer": {
+"description": "This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text.",
+"id": "GoogleCloudRetailV2betaConversationalSearchRequestUserAnswer",
+"properties": {
+"selectedAnswer": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer",
+"description": "Optional. This field specifies the selected answer during the conversational search. This should be a subset of ConversationalSearchResponse.followup_question.suggested_answers."
+},
+"textAnswer": {
+"description": "This field specifies the incremental input text from the user during the conversational search.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer": {
+"description": "This field specifies the selected answers during the conversational search.",
+"id": "GoogleCloudRetailV2betaConversationalSearchRequestUserAnswerSelectedAnswer",
+"properties": {
+"productAttributeValue": {
+"$ref": "GoogleCloudRetailV2betaProductAttributeValue",
+"description": "Optional. This field specifies the selected answer which is a attribute key-value."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaConversationalSearchResponse": {
+"description": "Response message for ConversationalSearchService.ConversationalSearch method.",
+"id": "GoogleCloudRetailV2betaConversationalSearchResponse",
+"properties": {
+"conversationId": {
+"description": "Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's ConversationalSearchRequest.conversation_id to restore conversation state in server.",
+"type": "string"
+},
+"conversationalFilteringResult": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult",
+"description": "This field specifies all related information that is needed on client side for UI rendering of conversational filtering search."
+},
+"conversationalTextResponse": {
+"description": "The conversational answer-based text response generated by the Server.",
+"type": "string"
+},
+"followupQuestion": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion",
+"description": "The conversational followup question generated for Intent refinement."
+},
+"refinedSearch": {
+"description": "The proposed refined search queries. They can be used to fetch the relevant search results. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.",
+"items": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch"
+},
+"type": "array"
+},
+"state": {
+"description": "Output only. The state of the response generation.",
+"enum": [
+"STATE_UNSPECIFIED",
+"STREAMING",
+"SUCCEEDED"
+],
+"enumDescriptions": [
+"Unknown.",
+"Response generation is being streamed.",
+"Response generation has succeeded."
+],
+"readOnly": true,
+"type": "string"
+},
+"userQueryTypes": {
+"description": "The types Retail classifies the search query as. Supported values are: - \"ORDER_SUPPORT\" - \"SIMPLE_PRODUCT_SEARCH\" - \"INTENT_REFINEMENT\" - \"PRODUCT_DETAILS\" - \"PRODUCT_COMPARISON\" - \"DEALS_AND_COUPONS\" - \"STORE_RELEVANT\" - \"BLOCKLISTED\" - \"BEST_PRODUCT\" - \"RETAIL_SUPPORT\" - \"DISABLED\"",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult": {
+"description": "This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.",
+"id": "GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResult",
+"properties": {
+"additionalFilter": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter",
+"description": "This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous ConversationalSearchRequest.search_params.filter and SearchRequest.filter, and use the merged filter in the follow up requests."
+},
+"followupQuestion": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion",
+"description": "The conversational filtering question."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter": {
+"description": "Additional filter that client side need to apply.",
+"id": "GoogleCloudRetailV2betaConversationalSearchResponseConversationalFilteringResultAdditionalFilter",
+"properties": {
+"productAttributeValue": {
+"$ref": "GoogleCloudRetailV2betaProductAttributeValue",
+"description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion": {
+"description": "The conversational followup question generated for Intent refinement.",
+"id": "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestion",
+"properties": {
+"followupQuestion": {
+"description": "The conversational followup question generated for Intent refinement.",
+"type": "string"
+},
+"suggestedAnswers": {
+"description": "The answer options provided to client for the follow-up question.",
+"items": {
+"$ref": "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer": {
+"description": "Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.",
+"id": "GoogleCloudRetailV2betaConversationalSearchResponseFollowupQuestionSuggestedAnswer",
+"properties": {
+"productAttributeValue": {
+"$ref": "GoogleCloudRetailV2betaProductAttributeValue",
+"description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch": {
+"description": "The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.",
+"id": "GoogleCloudRetailV2betaConversationalSearchResponseRefinedSearch",
+"properties": {
+"query": {
+"description": "The query to be used for search.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2betaCreateModelMetadata": {
 "description": "Metadata associated with a create operation.",
 "id": "GoogleCloudRetailV2betaCreateModelMetadata",
@@ -7155,6 +7466,67 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2betaSafetySetting": {
+"description": "Safety settings.",
+"id": "GoogleCloudRetailV2betaSafetySetting",
+"properties": {
+"category": {
+"description": "Harm category.",
+"enum": [
+"HARM_CATEGORY_UNSPECIFIED",
+"HARM_CATEGORY_HATE_SPEECH",
+"HARM_CATEGORY_DANGEROUS_CONTENT",
+"HARM_CATEGORY_HARASSMENT",
+"HARM_CATEGORY_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_CIVIC_INTEGRITY"
+],
+"enumDescriptions": [
+"The harm category is unspecified.",
+"The harm category is hate speech.",
+"The harm category is dangerous content.",
+"The harm category is harassment.",
+"The harm category is sexually explicit content.",
+"The harm category is civic integrity."
+],
+"type": "string"
+},
+"method": {
+"description": "Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.",
+"enum": [
+"HARM_BLOCK_METHOD_UNSPECIFIED",
+"SEVERITY",
+"PROBABILITY"
+],
+"enumDescriptions": [
+"The harm block method is unspecified.",
+"The harm block method uses both probability and severity scores.",
+"The harm block method uses the probability score."
+],
+"type": "string"
+},
+"threshold": {
+"description": "The harm block threshold.",
+"enum": [
+"HARM_BLOCK_THRESHOLD_UNSPECIFIED",
+"BLOCK_LOW_AND_ABOVE",
+"BLOCK_MEDIUM_AND_ABOVE",
+"BLOCK_ONLY_HIGH",
+"BLOCK_NONE",
+"OFF"
+],
+"enumDescriptions": [
+"Unspecified harm block threshold.",
+"Block low threshold and above (i.e. block more).",
+"Block medium threshold and above.",
+"Block only high threshold (i.e. block less).",
+"Block none.",
+"Turn off the safety filter."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2betaSearchRequest": {
 "description": "Request message for SearchService.Search method.",
 "id": "GoogleCloudRetailV2betaSearchRequest",

From cb86c15ebc719b02425ba6f5fc4694ae7cdec2f4 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:09 +0000
Subject: [PATCH 24/26] feat(sqladmin): update the api

#### sqladmin:v1

The following keys were added:
- resources.instances.methods.resetSslConfig.parameters.mode (Total Keys: 2)
- schemas.Message (Total Keys: 4)
- schemas.ReadPoolAutoScaleConfig (Total Keys: 10)
- schemas.Settings.properties.readPoolAutoScaleConfig.$ref (Total Keys: 1)
- schemas.SqlInstancesExecuteSqlResponse.properties.messages (Total Keys: 2)
- schemas.TargetMetric (Total Keys: 5)
- schemas.User.properties.iamStatus.type (Total Keys: 1)

#### sqladmin:v1beta4

The following keys were added:
- resources.instances.methods.resetSslConfig.parameters.mode (Total Keys: 2)
- schemas.Message (Total Keys: 4)
- schemas.ReadPoolAutoScaleConfig (Total Keys: 10)
- schemas.Settings.properties.readPoolAutoScaleConfig.$ref (Total Keys: 1)
- schemas.SqlInstancesExecuteSqlResponse.properties.messages (Total Keys: 2)
- schemas.TargetMetric (Total Keys: 5)
- schemas.User.properties.iamStatus.type (Total Keys: 1)
---
 docs/dyn/sqladmin_v1.Backups.html             |  56 ++++++++-
 docs/dyn/sqladmin_v1.instances.html           |  87 +++++++++++++-
 docs/dyn/sqladmin_v1.users.html               |   4 +
 docs/dyn/sqladmin_v1beta4.backups.html        |  56 ++++++++-
 docs/dyn/sqladmin_v1beta4.instances.html      |  87 +++++++++++++-
 docs/dyn/sqladmin_v1beta4.users.html          |   4 +
 .../documents/sqladmin.v1.json                | 113 +++++++++++++++++-
 .../documents/sqladmin.v1beta4.json           | 113 +++++++++++++++++-
 8 files changed, 500 insertions(+), 20 deletions(-)

diff --git a/docs/dyn/sqladmin_v1.Backups.html b/docs/dyn/sqladmin_v1.Backups.html
index df0e35ade7f..6f337bcbd98 100644
--- a/docs/dyn/sqladmin_v1.Backups.html
+++ b/docs/dyn/sqladmin_v1.Backups.html
@@ -105,7 +105,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # A backup resource. Next ID: 30
+{ # A backup resource.
   "backupInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
     "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
     "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
@@ -422,6 +422,18 @@ 
Method Details

         "reuseInterval": 42, # Number of previous passwords that cannot be reused.
       },
       "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+      "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+        "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+        "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+        "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+        "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+          { # Target metric for read pool auto scaling.
+            "metric": "A String", # The metric name to be used for auto scaling.
+            "targetValue": 3.14, # The target value for the metric.
+          },
+        ],
+      },
       "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag
       "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
       "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -781,7 +793,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # A backup resource. Next ID: 30
+    { # A backup resource.
   "backupInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
     "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
     "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
@@ -1098,6 +1110,18 @@ 
Method Details

         "reuseInterval": 42, # Number of previous passwords that cannot be reused.
       },
       "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+      "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+        "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+        "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+        "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+        "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+          { # Target metric for read pool auto scaling.
+            "metric": "A String", # The metric name to be used for auto scaling.
+            "targetValue": 3.14, # The target value for the metric.
+          },
+        ],
+      },
       "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag
       "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
       "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -1169,7 +1193,7 @@ 
Method Details

 
     { # The response payload containing a list of the backups.
   "backups": [ # A list of backups.
-    { # A backup resource. Next ID: 30
+    { # A backup resource.
       "backupInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
         "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
         "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
@@ -1486,6 +1510,18 @@ 
Method Details

             "reuseInterval": 42, # Number of previous passwords that cannot be reused.
           },
           "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+          "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+            "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+            "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+            "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+            "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+            "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+              { # Target metric for read pool auto scaling.
+                "metric": "A String", # The metric name to be used for auto scaling.
+                "targetValue": 3.14, # The target value for the metric.
+              },
+            ],
+          },
           "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag
           "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
           "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -1571,7 +1607,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # A backup resource. Next ID: 30
+{ # A backup resource.
   "backupInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
     "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
     "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
@@ -1888,6 +1924,18 @@ 
Method Details

         "reuseInterval": 42, # Number of previous passwords that cannot be reused.
       },
       "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+      "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+        "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+        "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+        "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+        "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+          { # Target metric for read pool auto scaling.
+            "metric": "A String", # The metric name to be used for auto scaling.
+            "targetValue": 3.14, # The target value for the metric.
+          },
+        ],
+      },
       "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag
       "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
       "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html
index cd8f85e67ef..5e7effe7fa4 100644
--- a/docs/dyn/sqladmin_v1.instances.html
+++ b/docs/dyn/sqladmin_v1.instances.html
@@ -147,7 +147,7 @@ 
Instance Methods

   releaseSsrsLease(project, instance, x__xgafv=None)

 
Release a lease for the setup of SQL Server Reporting Services (SSRS).

 

-  resetSslConfig(project, instance, x__xgafv=None)

+  resetSslConfig(project, instance, mode=None, x__xgafv=None)

 
Deletes all client certificates and generates a new server SSL certificate for the instance.

 

   restart(project, instance, x__xgafv=None)

@@ -1414,6 +1414,12 @@ 
Method Details

   An object of the form:
 
     { # Execute SQL statements response.
+  "messages": [ # A list of notices and warnings generated during query execution. For PostgreSQL, this includes all notices and warnings. For MySQL, this includes warnings generated by the last executed statement. To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must be executed after each statement.
+    { # Represents a notice or warning message from the database.
+      "message": "A String", # The full message string. For PostgreSQL, this is a formatted string that may include severity, code, and the notice/warning message. For MySQL, this contains the warning message.
+      "severity": "A String", # The severity of the message (e.g., "NOTICE" for PostgreSQL, "WARNING" for MySQL).
+    },
+  ],
   "metadata": { # The additional metadata information regarding the execution of the SQL statements. # The additional metadata information regarding the execution of the SQL statements.
     "sqlStatementExecutionTime": "A String", # The time taken to execute the SQL statements.
   },
@@ -2121,6 +2127,18 @@ 
Method Details

       "reuseInterval": 42, # Number of previous passwords that cannot be reused.
     },
     "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+    "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+      "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+      "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+      "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+      "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+        { # Target metric for read pool auto scaling.
+          "metric": "A String", # The metric name to be used for auto scaling.
+          "targetValue": 3.14, # The target value for the metric.
+        },
+      ],
+    },
     "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag
     "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
     "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -2670,6 +2688,18 @@ 
Method Details

       "reuseInterval": 42, # Number of previous passwords that cannot be reused.
     },
     "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+    "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+      "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+      "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+      "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+      "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+        { # Target metric for read pool auto scaling.
+          "metric": "A String", # The metric name to be used for auto scaling.
+          "targetValue": 3.14, # The target value for the metric.
+        },
+      ],
+    },
     "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag
     "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
     "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -3170,6 +3200,18 @@ 
Method Details

           "reuseInterval": 42, # Number of previous passwords that cannot be reused.
         },
         "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+        "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+          "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+          "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+          "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+          "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+          "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+            { # Target metric for read pool auto scaling.
+              "metric": "A String", # The metric name to be used for auto scaling.
+              "targetValue": 3.14, # The target value for the metric.
+            },
+          ],
+        },
         "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag
         "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
         "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -3577,6 +3619,18 @@ 
Method Details

       "reuseInterval": 42, # Number of previous passwords that cannot be reused.
     },
     "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+    "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+      "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+      "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+      "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+      "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+        { # Target metric for read pool auto scaling.
+          "metric": "A String", # The metric name to be used for auto scaling.
+          "targetValue": 3.14, # The target value for the metric.
+        },
+      ],
+    },
     "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag
     "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
     "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -4255,12 +4309,17 @@ 
Method Details
- resetSslConfig(project, instance, x__xgafv=None) + resetSslConfig(project, instance, mode=None, x__xgafv=None) 
Deletes all client certificates and generates a new server SSL certificate for the instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  mode: string, Optional. Reset SSL mode to use.
+    Allowed values
+      RESET_SSL_MODE_UNSPECIFIED - Reset SSL mode is not specified.
+      ALL - Refresh all TLS configs. This is the default behaviour.
+      SYNC_FROM_PRIMARY - Refreshes the replication-related TLS configuration settings provided by the primary instance. Not applicable to on-premises replication instances.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -4878,6 +4937,18 @@ 
Method Details

         "reuseInterval": 42, # Number of previous passwords that cannot be reused.
       },
       "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+      "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+        "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+        "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+        "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+        "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+          { # Target metric for read pool auto scaling.
+            "metric": "A String", # The metric name to be used for auto scaling.
+            "targetValue": 3.14, # The target value for the metric.
+          },
+        ],
+      },
       "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag
       "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
       "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -6146,6 +6217,18 @@ 
Method Details

       "reuseInterval": 42, # Number of previous passwords that cannot be reused.
     },
     "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+    "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+      "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+      "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+      "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+      "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+        { # Target metric for read pool auto scaling.
+          "metric": "A String", # The metric name to be used for auto scaling.
+          "targetValue": 3.14, # The target value for the metric.
+        },
+      ],
+    },
     "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag
     "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
     "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
diff --git a/docs/dyn/sqladmin_v1.users.html b/docs/dyn/sqladmin_v1.users.html
index 3f9ebf1f6c9..4c0acb725b1 100644
--- a/docs/dyn/sqladmin_v1.users.html
+++ b/docs/dyn/sqladmin_v1.users.html
@@ -272,6 +272,7 @@ 
Method Details

   "dualPasswordType": "A String", # Dual password status for the user.
   "etag": "A String", # This field is deprecated and will be removed from a future version of the API.
   "host": "A String", # Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
+  "iamStatus": "A String", # Indicates if a group is active or inactive for IAM database authentication.
   "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL.
   "kind": "A String", # This is always `sql#user`.
   "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL.
@@ -311,6 +312,7 @@ 
Method Details

   "dualPasswordType": "A String", # Dual password status for the user.
   "etag": "A String", # This field is deprecated and will be removed from a future version of the API.
   "host": "A String", # Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
+  "iamStatus": "A String", # Indicates if a group is active or inactive for IAM database authentication.
   "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL.
   "kind": "A String", # This is always `sql#user`.
   "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL.
@@ -500,6 +502,7 @@ 
Method Details

       "dualPasswordType": "A String", # Dual password status for the user.
       "etag": "A String", # This field is deprecated and will be removed from a future version of the API.
       "host": "A String", # Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
+      "iamStatus": "A String", # Indicates if a group is active or inactive for IAM database authentication.
       "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL.
       "kind": "A String", # This is always `sql#user`.
       "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL.
@@ -543,6 +546,7 @@ 
Method Details

   "dualPasswordType": "A String", # Dual password status for the user.
   "etag": "A String", # This field is deprecated and will be removed from a future version of the API.
   "host": "A String", # Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
+  "iamStatus": "A String", # Indicates if a group is active or inactive for IAM database authentication.
   "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL.
   "kind": "A String", # This is always `sql#user`.
   "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL.
diff --git a/docs/dyn/sqladmin_v1beta4.backups.html b/docs/dyn/sqladmin_v1beta4.backups.html
index fd081e49d6e..e44b25c5f57 100644
--- a/docs/dyn/sqladmin_v1beta4.backups.html
+++ b/docs/dyn/sqladmin_v1beta4.backups.html
@@ -110,7 +110,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # A backup resource. Next ID: 30
+{ # A backup resource.
   "backupInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
     "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
     "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
@@ -427,6 +427,18 @@ 
Method Details

         "reuseInterval": 42, # Number of previous passwords that cannot be reused.
       },
       "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+      "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+        "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+        "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+        "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+        "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+          { # Target metric for read pool auto scaling.
+            "metric": "A String", # The metric name to be used for auto scaling.
+            "targetValue": 3.14, # The target value for the metric.
+          },
+        ],
+      },
       "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag.
       "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
       "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -786,7 +798,7 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # A backup resource. Next ID: 30
+    { # A backup resource.
   "backupInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
     "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
     "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
@@ -1103,6 +1115,18 @@ 
Method Details

         "reuseInterval": 42, # Number of previous passwords that cannot be reused.
       },
       "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+      "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+        "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+        "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+        "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+        "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+          { # Target metric for read pool auto scaling.
+            "metric": "A String", # The metric name to be used for auto scaling.
+            "targetValue": 3.14, # The target value for the metric.
+          },
+        ],
+      },
       "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag.
       "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
       "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -1174,7 +1198,7 @@ 
Method Details

 
     { # The response payload containing a list of the backups.
   "backups": [ # A list of backups.
-    { # A backup resource. Next ID: 30
+    { # A backup resource.
       "backupInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
         "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
         "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
@@ -1491,6 +1515,18 @@ 
Method Details

             "reuseInterval": 42, # Number of previous passwords that cannot be reused.
           },
           "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+          "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+            "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+            "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+            "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+            "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+            "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+              { # Target metric for read pool auto scaling.
+                "metric": "A String", # The metric name to be used for auto scaling.
+                "targetValue": 3.14, # The target value for the metric.
+              },
+            ],
+          },
           "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag.
           "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
           "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -1576,7 +1612,7 @@ 
Method Details

   body: object, The request body.
     The object takes the form of:
 
-{ # A backup resource. Next ID: 30
+{ # A backup resource.
   "backupInterval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
     "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
     "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
@@ -1893,6 +1929,18 @@ 
Method Details

         "reuseInterval": 42, # Number of previous passwords that cannot be reused.
       },
       "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+      "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+        "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+        "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+        "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+        "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+          { # Target metric for read pool auto scaling.
+            "metric": "A String", # The metric name to be used for auto scaling.
+            "targetValue": 3.14, # The target value for the metric.
+          },
+        ],
+      },
       "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag.
       "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
       "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html
index 9941dfc9d16..6314e1f5abe 100644
--- a/docs/dyn/sqladmin_v1beta4.instances.html
+++ b/docs/dyn/sqladmin_v1beta4.instances.html
@@ -147,7 +147,7 @@ 
Instance Methods

   releaseSsrsLease(project, instance, x__xgafv=None)

 
Release a lease for the setup of SQL Server Reporting Services (SSRS).

 

-  resetSslConfig(project, instance, x__xgafv=None)

+  resetSslConfig(project, instance, mode=None, x__xgafv=None)

 
Deletes all client certificates and generates a new server SSL certificate for the instance.

 

   restart(project, instance, x__xgafv=None)

@@ -1414,6 +1414,12 @@ 
Method Details

   An object of the form:
 
     { # Execute SQL statements response.
+  "messages": [ # A list of notices and warnings generated during query execution. For PostgreSQL, this includes all notices and warnings. For MySQL, this includes warnings generated by the last executed statement. To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must be executed after each statement.
+    { # Represents a notice or warning message from the database.
+      "message": "A String", # The full message string. For PostgreSQL, this is a formatted string that may include severity, code, and the notice/warning message. For MySQL, this contains the warning message.
+      "severity": "A String", # The severity of the message (e.g., "NOTICE" for PostgreSQL, "WARNING" for MySQL).
+    },
+  ],
   "metadata": { # The additional metadata information regarding the execution of the SQL statements. # The additional metadata information regarding the execution of the SQL statements.
     "sqlStatementExecutionTime": "A String", # The time taken to execute the SQL statements.
   },
@@ -2121,6 +2127,18 @@ 
Method Details

       "reuseInterval": 42, # Number of previous passwords that cannot be reused.
     },
     "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+    "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+      "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+      "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+      "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+      "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+        { # Target metric for read pool auto scaling.
+          "metric": "A String", # The metric name to be used for auto scaling.
+          "targetValue": 3.14, # The target value for the metric.
+        },
+      ],
+    },
     "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag.
     "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
     "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -2670,6 +2688,18 @@ 
Method Details

       "reuseInterval": 42, # Number of previous passwords that cannot be reused.
     },
     "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+    "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+      "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+      "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+      "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+      "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+        { # Target metric for read pool auto scaling.
+          "metric": "A String", # The metric name to be used for auto scaling.
+          "targetValue": 3.14, # The target value for the metric.
+        },
+      ],
+    },
     "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag.
     "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
     "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -3170,6 +3200,18 @@ 
Method Details

           "reuseInterval": 42, # Number of previous passwords that cannot be reused.
         },
         "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+        "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+          "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+          "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+          "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+          "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+          "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+            { # Target metric for read pool auto scaling.
+              "metric": "A String", # The metric name to be used for auto scaling.
+              "targetValue": 3.14, # The target value for the metric.
+            },
+          ],
+        },
         "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag.
         "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
         "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -3577,6 +3619,18 @@ 
Method Details

       "reuseInterval": 42, # Number of previous passwords that cannot be reused.
     },
     "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+    "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+      "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+      "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+      "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+      "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+        { # Target metric for read pool auto scaling.
+          "metric": "A String", # The metric name to be used for auto scaling.
+          "targetValue": 3.14, # The target value for the metric.
+        },
+      ],
+    },
     "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag.
     "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
     "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -4255,12 +4309,17 @@ 
Method Details
- resetSslConfig(project, instance, x__xgafv=None) + resetSslConfig(project, instance, mode=None, x__xgafv=None) 
Deletes all client certificates and generates a new server SSL certificate for the instance.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
   instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+  mode: string, Optional. Reset SSL mode to use.
+    Allowed values
+      RESET_SSL_MODE_UNSPECIFIED - Reset SSL mode is not specified.
+      ALL - Refresh all TLS configs. This is the default behaviour.
+      SYNC_FROM_PRIMARY - Refreshes the replication-related TLS configuration settings provided by the primary instance. Not applicable to on-premises replication instances.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -4878,6 +4937,18 @@ 
Method Details

         "reuseInterval": 42, # Number of previous passwords that cannot be reused.
       },
       "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+      "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+        "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+        "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+        "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+        "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+        "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+          { # Target metric for read pool auto scaling.
+            "metric": "A String", # The metric name to be used for auto scaling.
+            "targetValue": 3.14, # The target value for the metric.
+          },
+        ],
+      },
       "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag.
       "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
       "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
@@ -6146,6 +6217,18 @@ 
Method Details

       "reuseInterval": 42, # Number of previous passwords that cannot be reused.
     },
     "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
+    "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance.
+      "disableScaleIn": True or False, # Indicates whether read pool auto scaling supports scale in operations (removing nodes).
+      "enabled": True or False, # Indicates whether read pool auto scaling is enabled.
+      "maxNodeCount": 42, # Maximum number of read pool nodes to be maintained.
+      "minNodeCount": 42, # Minimum number of read pool nodes to be maintained.
+      "targetMetrics": [ # Optional. Target metrics for read pool auto scaling.
+        { # Target metric for read pool auto scaling.
+          "metric": "A String", # The metric name to be used for auto scaling.
+          "targetValue": 3.14, # The target value for the metric.
+        },
+      ],
+    },
     "replicationLagMaxSeconds": 42, # Optional. Configuration value for recreation of replica after certain replication lag.
     "replicationType": "A String", # The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
     "retainBackupsOnDelete": True or False, # Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
diff --git a/docs/dyn/sqladmin_v1beta4.users.html b/docs/dyn/sqladmin_v1beta4.users.html
index 1e651493a62..b0fa46522fb 100644
--- a/docs/dyn/sqladmin_v1beta4.users.html
+++ b/docs/dyn/sqladmin_v1beta4.users.html
@@ -272,6 +272,7 @@ 
Method Details

   "dualPasswordType": "A String", # Dual password status for the user.
   "etag": "A String", # This field is deprecated and will be removed from a future version of the API.
   "host": "A String", # Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
+  "iamStatus": "A String", # Indicates if a group is active or inactive for IAM database authentication.
   "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* because it is already specified on the URL.
   "kind": "A String", # This is always `sql#user`.
   "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL.
@@ -311,6 +312,7 @@ 
Method Details

   "dualPasswordType": "A String", # Dual password status for the user.
   "etag": "A String", # This field is deprecated and will be removed from a future version of the API.
   "host": "A String", # Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
+  "iamStatus": "A String", # Indicates if a group is active or inactive for IAM database authentication.
   "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* because it is already specified on the URL.
   "kind": "A String", # This is always `sql#user`.
   "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL.
@@ -500,6 +502,7 @@ 
Method Details

       "dualPasswordType": "A String", # Dual password status for the user.
       "etag": "A String", # This field is deprecated and will be removed from a future version of the API.
       "host": "A String", # Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
+      "iamStatus": "A String", # Indicates if a group is active or inactive for IAM database authentication.
       "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* because it is already specified on the URL.
       "kind": "A String", # This is always `sql#user`.
       "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL.
@@ -543,6 +546,7 @@ 
Method Details

   "dualPasswordType": "A String", # Dual password status for the user.
   "etag": "A String", # This field is deprecated and will be removed from a future version of the API.
   "host": "A String", # Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
+  "iamStatus": "A String", # Indicates if a group is active or inactive for IAM database authentication.
   "instance": "A String", # The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* because it is already specified on the URL.
   "kind": "A String", # This is always `sql#user`.
   "name": "A String", # The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL.
diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json
index 2d251b696e1..a10aa2b4002 100644
--- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json
+++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json
@@ -1565,6 +1565,21 @@
 "required": true,
 "type": "string"
 },
+"mode": {
+"description": "Optional. Reset SSL mode to use.",
+"enum": [
+"RESET_SSL_MODE_UNSPECIFIED",
+"ALL",
+"SYNC_FROM_PRIMARY"
+],
+"enumDescriptions": [
+"Reset SSL mode is not specified.",
+"Refresh all TLS configs. This is the default behaviour.",
+"Refreshes the replication-related TLS configuration settings provided by the primary instance. Not applicable to on-premises replication instances."
+],
+"location": "query",
+"type": "string"
+},
 "project": {
 "description": "Project ID of the project that contains the instance.",
 "location": "path",
@@ -2635,7 +2650,7 @@
 }
 }
 },
-"revision": "20250823",
+"revision": "20250908",
 "rootUrl": "https://sqladmin.googleapis.com/",
 "schemas": {
 "AclEntry": {
@@ -2751,7 +2766,7 @@
 "type": "object"
 },
 "Backup": {
-"description": "A backup resource. Next ID: 30",
+"description": "A backup resource.",
 "id": "Backup",
 "properties": {
 "backupInterval": {
@@ -6047,6 +6062,21 @@ false
 },
 "type": "object"
 },
+"Message": {
+"description": "Represents a notice or warning message from the database.",
+"id": "Message",
+"properties": {
+"message": {
+"description": "The full message string. For PostgreSQL, this is a formatted string that may include severity, code, and the notice/warning message. For MySQL, this contains the warning message.",
+"type": "string"
+},
+"severity": {
+"description": "The severity of the message (e.g., \"NOTICE\" for PostgreSQL, \"WARNING\" for MySQL).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Metadata": {
 "description": "The additional metadata information regarding the execution of the SQL statements.",
 "id": "Metadata",
@@ -6826,6 +6856,38 @@ false
 },
 "type": "object"
 },
+"ReadPoolAutoScaleConfig": {
+"description": "The read pool auto-scale configuration.",
+"id": "ReadPoolAutoScaleConfig",
+"properties": {
+"disableScaleIn": {
+"description": "Indicates whether read pool auto scaling supports scale in operations (removing nodes).",
+"type": "boolean"
+},
+"enabled": {
+"description": "Indicates whether read pool auto scaling is enabled.",
+"type": "boolean"
+},
+"maxNodeCount": {
+"description": "Maximum number of read pool nodes to be maintained.",
+"format": "int32",
+"type": "integer"
+},
+"minNodeCount": {
+"description": "Minimum number of read pool nodes to be maintained.",
+"format": "int32",
+"type": "integer"
+},
+"targetMetrics": {
+"description": "Optional. Target metrics for read pool auto scaling.",
+"items": {
+"$ref": "TargetMetric"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "ReplicaConfiguration": {
 "description": "Read-replica configuration for connecting to the primary instance.",
 "id": "ReplicaConfiguration",
@@ -7193,6 +7255,10 @@ false
 ],
 "type": "string"
 },
+"readPoolAutoScaleConfig": {
+"$ref": "ReadPoolAutoScaleConfig",
+"description": "Optional. The read pool auto-scale configuration for the instance."
+},
 "replicationLagMaxSeconds": {
 "description": "Optional. Configuration value for recreation of replica after certain replication lag",
 "format": "int32",
@@ -7369,7 +7435,8 @@ false
 "PSC_ONLY_INSTANCE_WITH_NO_NETWORK_ATTACHMENT_URI",
 "SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS",
 "PROMPT_DELETE_EXISTING",
-"WILL_DELETE_EXISTING"
+"WILL_DELETE_EXISTING",
+"PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE"
 ],
 "enumDescriptions": [
 "",
@@ -7429,7 +7496,8 @@ false
 "PSC only destination instance does not have a network attachment URI.",
 "Selected objects reference unselected objects. Based on their object type (foreign key constraint or view), selected objects will fail during migration.",
 "The migration will delete existing data in the replica; set replica_overwrite_enabled in the request to acknowledge this. This is an error. MySQL only.",
-"The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only."
+"The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only.",
+"The replication user is missing specific privileges to setup DDL replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL."
 ],
 "type": "string"
 }
@@ -7451,6 +7519,13 @@ false
 "description": "Execute SQL statements response.",
 "id": "SqlInstancesExecuteSqlResponse",
 "properties": {
+"messages": {
+"description": "A list of notices and warnings generated during query execution. For PostgreSQL, this includes all notices and warnings. For MySQL, this includes warnings generated by the last executed statement. To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must be executed after each statement.",
+"items": {
+"$ref": "Message"
+},
+"type": "array"
+},
 "metadata": {
 "$ref": "Metadata",
 "description": "The additional metadata information regarding the execution of the SQL statements."
@@ -7969,6 +8044,22 @@ false
 },
 "type": "object"
 },
+"TargetMetric": {
+"description": "Target metric for read pool auto scaling.",
+"id": "TargetMetric",
+"properties": {
+"metric": {
+"description": "The metric name to be used for auto scaling.",
+"type": "string"
+},
+"targetValue": {
+"description": "The target value for the metric.",
+"format": "float",
+"type": "number"
+}
+},
+"type": "object"
+},
 "Tier": {
 "description": "A Google Cloud SQL service tier resource.",
 "id": "Tier",
@@ -8062,6 +8153,20 @@ false
 "description": "Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.",
 "type": "string"
 },
+"iamStatus": {
+"description": "Indicates if a group is active or inactive for IAM database authentication.",
+"enum": [
+"IAM_STATUS_UNSPECIFIED",
+"INACTIVE",
+"ACTIVE"
+],
+"enumDescriptions": [
+"The default value for users that are not of type CLOUD_IAM_GROUP. Only CLOUD_IAM_GROUP users will be inactive or active. Users with an IamStatus of IAM_STATUS_UNSPECIFIED will not display whether they are active or inactive as that is not applicable to them.",
+"INACTIVE indicates a group is not available for IAM database authentication.",
+"ACTIVE indicates a group is available for IAM database authentication."
+],
+"type": "string"
+},
 "instance": {
 "description": "The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL.",
 "type": "string"
diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
index f62dfaffed9..78b56a7a2fe 100644
--- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
+++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json
@@ -1565,6 +1565,21 @@
 "required": true,
 "type": "string"
 },
+"mode": {
+"description": "Optional. Reset SSL mode to use.",
+"enum": [
+"RESET_SSL_MODE_UNSPECIFIED",
+"ALL",
+"SYNC_FROM_PRIMARY"
+],
+"enumDescriptions": [
+"Reset SSL mode is not specified.",
+"Refresh all TLS configs. This is the default behaviour.",
+"Refreshes the replication-related TLS configuration settings provided by the primary instance. Not applicable to on-premises replication instances."
+],
+"location": "query",
+"type": "string"
+},
 "project": {
 "description": "Project ID of the project that contains the instance.",
 "location": "path",
@@ -2635,7 +2650,7 @@
 }
 }
 },
-"revision": "20250823",
+"revision": "20250908",
 "rootUrl": "https://sqladmin.googleapis.com/",
 "schemas": {
 "AclEntry": {
@@ -2751,7 +2766,7 @@
 "type": "object"
 },
 "Backup": {
-"description": "A backup resource. Next ID: 30",
+"description": "A backup resource.",
 "id": "Backup",
 "properties": {
 "backupInterval": {
@@ -6048,6 +6063,21 @@ false
 },
 "type": "object"
 },
+"Message": {
+"description": "Represents a notice or warning message from the database.",
+"id": "Message",
+"properties": {
+"message": {
+"description": "The full message string. For PostgreSQL, this is a formatted string that may include severity, code, and the notice/warning message. For MySQL, this contains the warning message.",
+"type": "string"
+},
+"severity": {
+"description": "The severity of the message (e.g., \"NOTICE\" for PostgreSQL, \"WARNING\" for MySQL).",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Metadata": {
 "description": "The additional metadata information regarding the execution of the SQL statements.",
 "id": "Metadata",
@@ -6827,6 +6857,38 @@ false
 },
 "type": "object"
 },
+"ReadPoolAutoScaleConfig": {
+"description": "The read pool auto-scale configuration.",
+"id": "ReadPoolAutoScaleConfig",
+"properties": {
+"disableScaleIn": {
+"description": "Indicates whether read pool auto scaling supports scale in operations (removing nodes).",
+"type": "boolean"
+},
+"enabled": {
+"description": "Indicates whether read pool auto scaling is enabled.",
+"type": "boolean"
+},
+"maxNodeCount": {
+"description": "Maximum number of read pool nodes to be maintained.",
+"format": "int32",
+"type": "integer"
+},
+"minNodeCount": {
+"description": "Minimum number of read pool nodes to be maintained.",
+"format": "int32",
+"type": "integer"
+},
+"targetMetrics": {
+"description": "Optional. Target metrics for read pool auto scaling.",
+"items": {
+"$ref": "TargetMetric"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "ReplicaConfiguration": {
 "description": "Read-replica configuration for connecting to the primary instance.",
 "id": "ReplicaConfiguration",
@@ -7194,6 +7256,10 @@ false
 ],
 "type": "string"
 },
+"readPoolAutoScaleConfig": {
+"$ref": "ReadPoolAutoScaleConfig",
+"description": "Optional. The read pool auto-scale configuration for the instance."
+},
 "replicationLagMaxSeconds": {
 "description": "Optional. Configuration value for recreation of replica after certain replication lag.",
 "format": "int32",
@@ -7370,7 +7436,8 @@ false
 "PSC_ONLY_INSTANCE_WITH_NO_NETWORK_ATTACHMENT_URI",
 "SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS",
 "PROMPT_DELETE_EXISTING",
-"WILL_DELETE_EXISTING"
+"WILL_DELETE_EXISTING",
+"PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE"
 ],
 "enumDescriptions": [
 "",
@@ -7430,7 +7497,8 @@ false
 "PSC only destination instance does not have a network attachment URI.",
 "Selected objects reference unselected objects. Based on their object type (foreign key constraint or view), selected objects will fail during migration.",
 "The migration will delete existing data in the replica; set replica_overwrite_enabled in the request to acknowledge this. This is an error. MySQL only.",
-"The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only."
+"The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only.",
+"The replication user is missing specific privileges to setup DDL replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL."
 ],
 "type": "string"
 }
@@ -7452,6 +7520,13 @@ false
 "description": "Execute SQL statements response.",
 "id": "SqlInstancesExecuteSqlResponse",
 "properties": {
+"messages": {
+"description": "A list of notices and warnings generated during query execution. For PostgreSQL, this includes all notices and warnings. For MySQL, this includes warnings generated by the last executed statement. To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must be executed after each statement.",
+"items": {
+"$ref": "Message"
+},
+"type": "array"
+},
 "metadata": {
 "$ref": "Metadata",
 "description": "The additional metadata information regarding the execution of the SQL statements."
@@ -7968,6 +8043,22 @@ false
 },
 "type": "object"
 },
+"TargetMetric": {
+"description": "Target metric for read pool auto scaling.",
+"id": "TargetMetric",
+"properties": {
+"metric": {
+"description": "The metric name to be used for auto scaling.",
+"type": "string"
+},
+"targetValue": {
+"description": "The target value for the metric.",
+"format": "float",
+"type": "number"
+}
+},
+"type": "object"
+},
 "Tier": {
 "description": "A Google Cloud SQL service tier resource.",
 "id": "Tier",
@@ -8061,6 +8152,20 @@ false
 "description": "Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.",
 "type": "string"
 },
+"iamStatus": {
+"description": "Indicates if a group is active or inactive for IAM database authentication.",
+"enum": [
+"IAM_STATUS_UNSPECIFIED",
+"INACTIVE",
+"ACTIVE"
+],
+"enumDescriptions": [
+"The default value for users that are not of type CLOUD_IAM_GROUP. Only CLOUD_IAM_GROUP users will be inactive or active. Users with an IamStatus of IAM_STATUS_UNSPECIFIED will not display whether they are active or inactive as that is not applicable to them.",
+"INACTIVE indicates a group is not available for IAM database authentication.",
+"ACTIVE indicates a group is available for IAM database authentication."
+],
+"type": "string"
+},
 "instance": {
 "description": "The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* because it is already specified on the URL.",
 "type": "string"

From b5aaa05ab795abfe10e741bb65877df4d89301c2 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:09 +0000
Subject: [PATCH 25/26] feat(workloadmanager): update the api

#### workloadmanager:v1

The following keys were added:
- schemas.Insight.properties.openShiftValidation.$ref (Total Keys: 1)
- schemas.OpenShiftValidation (Total Keys: 2)
---
 ...rkloadmanager_v1.projects.locations.insights.html |  2 ++
 .../documents/workloadmanager.v1.json                | 12 +++++++++++-
 2 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/workloadmanager_v1.projects.locations.insights.html b/docs/dyn/workloadmanager_v1.projects.locations.insights.html
index 457b321ec37..4bc6186cfd4 100644
--- a/docs/dyn/workloadmanager_v1.projects.locations.insights.html
+++ b/docs/dyn/workloadmanager_v1.projects.locations.insights.html
@@ -178,6 +178,8 @@ 
Method Details

       "systemdServiceRunning": "A String", # Output only. Whether the agent service is running in systemd.
     },
     "instanceId": "A String", # Optional. The instance id where the insight is generated from
+    "openShiftValidation": { # A presentation of OpenShift workload insight. The schema of OpenShift workloads validation related data. # The insights data for the OpenShift workload validation.
+    },
     "sapDiscovery": { # The schema of SAP system discovery data. # The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes.
       "applicationLayer": { # Message describing the system component. # Optional. An SAP system may run without an application layer.
         "applicationProperties": { # A set of properties describing an SAP Application layer. # Optional. The component is a SAP application.
diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json
index 0eecd5109a0..3705652c115 100644
--- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json
@@ -879,7 +879,7 @@ true
 }
 }
 },
-"revision": "20250903",
+"revision": "20250910",
 "rootUrl": "https://workloadmanager.googleapis.com/",
 "schemas": {
 "AgentCommand": {
@@ -1690,6 +1690,10 @@ true
 "description": "Optional. The instance id where the insight is generated from",
 "type": "string"
 },
+"openShiftValidation": {
+"$ref": "OpenShiftValidation",
+"description": "The insights data for the OpenShift workload validation."
+},
 "sapDiscovery": {
 "$ref": "SapDiscovery",
 "description": "The insights data for SAP system discovery. This is a copy of SAP System proto and should get updated whenever that one changes."
@@ -1978,6 +1982,12 @@ true
 },
 "type": "object"
 },
+"OpenShiftValidation": {
+"description": "A presentation of OpenShift workload insight. The schema of OpenShift workloads validation related data.",
+"id": "OpenShiftValidation",
+"properties": {},
+"type": "object"
+},
 "Operation": {
 "description": "This resource represents a long-running operation that is the result of a network API call.",
 "id": "Operation",

From c86c6b66f65690e368940e8685191e7f515819ed Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 23 Sep 2025 07:09:09 +0000
Subject: [PATCH 26/26] chore(docs): Add new discovery artifacts and artifacts
 with minor updates

---
 ...sapproval_v1.folders.approvalRequests.html | 68 ++++++++--------
 docs/dyn/accessapproval_v1.folders.html       | 62 +++++++-------
 ...val_v1.organizations.approvalRequests.html | 68 ++++++++--------
 docs/dyn/accessapproval_v1.organizations.html | 62 +++++++-------
 ...approval_v1.projects.approvalRequests.html | 68 ++++++++--------
 docs/dyn/accessapproval_v1.projects.html      | 62 +++++++-------
 .../admin_directory_v1.chromeosdevices.html   | 12 +--
 docs/dyn/admin_directory_v1.groups.html       |  2 +-
 docs/dyn/admin_directory_v1.users.html        |  2 +-
 .../dyn/apigateway_v1.projects.locations.html |  2 +-
 .../apigateway_v1beta.projects.locations.html |  2 +-
 docs/dyn/apim_v1alpha.projects.locations.html |  2 +-
 docs/dyn/backupdr_v1.projects.locations.html  |  2 +-
 .../dyn/beyondcorp_v1.projects.locations.html |  2 +-
 ...beyondcorp_v1alpha.projects.locations.html |  2 +-
 ...tificatemanager_v1.projects.locations.html |  2 +-
 .../clouddeploy_v1.projects.locations.html    |  2 +-
 docs/dyn/config_v1.projects.locations.html    |  2 +-
 ...rojects.locations.entryGroups.entries.html |  8 +-
 docs/dyn/dataplex_v1.projects.locations.html  |  4 +-
 ...ex_v1.projects.locations.metadataJobs.html |  6 +-
 docs/dyn/drive_v3.accessproposals.html        | 80 +++++++++----------
 docs/dyn/file_v1.projects.locations.html      |  2 +-
 docs/dyn/file_v1beta1.projects.locations.html |  2 +-
 docs/dyn/firestore_v1.projects.locations.html |  2 +-
 docs/dyn/looker_v1.projects.locations.html    |  2 +-
 .../managedkafka_v1.projects.locations.html   |  2 +-
 docs/dyn/metastore_v1.projects.locations.html |  2 +-
 .../metastore_v1alpha.projects.locations.html |  2 +-
 .../metastore_v1beta.projects.locations.html  |  2 +-
 .../parallelstore_v1.projects.locations.html  |  2 +-
 ...rallelstore_v1beta.projects.locations.html |  2 +-
 ...arametermanager_v1.projects.locations.html |  2 +-
 docs/dyn/privateca_v1.projects.locations.html |  2 +-
 .../privateca_v1beta1.projects.locations.html |  2 +-
 docs/dyn/run_v1.namespaces.jobs.html          |  2 +-
 ...ervicemgmt_v1beta1.projects.locations.html |  2 +-
 .../secretmanager_v1.projects.locations.html  |  2 +-
 ...retmanager_v1beta1.projects.locations.html |  2 +-
 ...retmanager_v1beta2.projects.locations.html |  2 +-
 ...ervicedirectory_v1.projects.locations.html |  2 +-
 ...edirectory_v1beta1.projects.locations.html |  2 +-
 ...batchoperations_v1.projects.locations.html |  2 +-
 .../texttospeech_v1.projects.locations.html   |  2 +-
 docs/dyn/texttospeech_v1.text.html            |  2 +-
 ...xttospeech_v1beta1.projects.locations.html |  2 +-
 docs/dyn/texttospeech_v1beta1.text.html       |  2 +-
 docs/dyn/vpcaccess_v1.projects.locations.html |  2 +-
 .../vpcaccess_v1beta1.projects.locations.html |  2 +-
 .../workstations_v1.projects.locations.html   |  2 +-
 .../documents/accessapproval.v1.json          | 72 ++++++++---------
 .../documents/admin.directory_v1.json         |  8 +-
 .../documents/apigateway.v1.json              |  4 +-
 .../documents/apigateway.v1beta.json          |  4 +-
 .../documents/apim.v1alpha.json               |  4 +-
 .../documents/backupdr.v1.json                |  4 +-
 .../documents/beyondcorp.v1.json              |  4 +-
 .../documents/beyondcorp.v1alpha.json         |  4 +-
 .../documents/certificatemanager.v1.json      |  4 +-
 .../documents/clouddeploy.v1.json             |  4 +-
 .../discovery_cache/documents/config.v1.json  |  4 +-
 .../documents/contactcenterinsights.v1.json   |  6 +-
 .../documents/dataplex.v1.json                | 16 ++--
 .../discovery_cache/documents/drive.v3.json   | 58 +++++++-------
 .../discovery_cache/documents/file.v1.json    |  4 +-
 .../documents/file.v1beta1.json               |  4 +-
 .../documents/firestore.v1.json               |  4 +-
 .../discovery_cache/documents/looker.v1.json  |  4 +-
 .../documents/managedkafka.v1.json            |  4 +-
 .../documents/metastore.v1.json               |  4 +-
 .../documents/metastore.v1alpha.json          |  4 +-
 .../documents/metastore.v1beta.json           |  4 +-
 .../documents/parallelstore.v1.json           |  4 +-
 .../documents/parallelstore.v1beta.json       |  4 +-
 .../documents/parametermanager.v1.json        |  4 +-
 .../documents/privateca.v1.json               |  4 +-
 .../documents/privateca.v1beta1.json          |  4 +-
 .../discovery_cache/documents/run.v1.json     |  4 +-
 .../documents/saasservicemgmt.v1beta1.json    |  4 +-
 .../documents/secretmanager.v1.json           |  4 +-
 .../documents/secretmanager.v1beta1.json      |  4 +-
 .../documents/secretmanager.v1beta2.json      |  4 +-
 .../documents/securitycenter.v1.json          | 34 +++++---
 .../documents/securitycenter.v1beta1.json     | 34 +++++---
 .../documents/securitycenter.v1beta2.json     | 34 +++++---
 .../documents/servicedirectory.v1.json        |  4 +-
 .../documents/servicedirectory.v1beta1.json   |  4 +-
 .../documents/storagebatchoperations.v1.json  |  4 +-
 .../documents/texttospeech.v1.json            |  4 +-
 .../documents/texttospeech.v1beta1.json       |  4 +-
 .../documents/vpcaccess.v1.json               |  4 +-
 .../documents/vpcaccess.v1beta1.json          |  4 +-
 .../documents/workstations.v1.json            |  4 +-
 93 files changed, 517 insertions(+), 463 deletions(-)

diff --git a/docs/dyn/accessapproval_v1.folders.approvalRequests.html b/docs/dyn/accessapproval_v1.folders.approvalRequests.html
index f9dea5ffbbe..1ab21e4adb1 100644
--- a/docs/dyn/accessapproval_v1.folders.approvalRequests.html
+++ b/docs/dyn/accessapproval_v1.folders.approvalRequests.html
@@ -82,13 +82,13 @@ 
Instance Methods

 
Close httplib2 connections.

 

   dismiss(name, body=None, x__xgafv=None)

-
Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

+
Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

 

   get(name, x__xgafv=None)

 
Gets an approval request. Returns NOT_FOUND if the request does not exist.

 

   invalidate(name, body=None, x__xgafv=None)

-
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

+
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

 

   list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

 
Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

@@ -138,18 +138,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -165,7 +165,7 @@ 
Method Details

 
 

     dismiss(name, body=None, x__xgafv=None)
-  
Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
+  
Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
 
 Args:
   name: string, Name of the ApprovalRequest to dismiss. (required)
@@ -204,18 +204,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -259,18 +259,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -281,7 +281,7 @@ 
Method Details

 
 

     invalidate(name, body=None, x__xgafv=None)
-  
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
+  
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
 
 Args:
   name: string, Name of the ApprovalRequest to invalidate. (required)
@@ -320,18 +320,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -380,18 +380,18 @@ 
Method Details

       },
       "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
       "requestTime": "A String", # The time at which approval was requested.
-      "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+      "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
         "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
       },
       "requestedDuration": "A String", # The requested access duration.
       "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-      "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-        "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-        "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+      "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+        "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+        "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
       },
-      "requestedReason": { # The justification for which approval is being requested.
+      "requestedReason": { # The access reason for which approval is being requested.
         "detail": "A String", # More detail about certain reason types. See comments for each type above.
-        "type": "A String", # Type of access justification.
+        "type": "A String", # Type of access reason.
       },
       "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
       "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
diff --git a/docs/dyn/accessapproval_v1.folders.html b/docs/dyn/accessapproval_v1.folders.html
index 66ad29a504d..9beeacc5cf8 100644
--- a/docs/dyn/accessapproval_v1.folders.html
+++ b/docs/dyn/accessapproval_v1.folders.html
@@ -84,10 +84,10 @@ 
Instance Methods

 
Close httplib2 connections.

 

   deleteAccessApprovalSettings(name, x__xgafv=None)

-
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

+
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.

 

   getAccessApprovalSettings(name, x__xgafv=None)

-
Gets the settings associated with a project, folder, or organization.

+
Gets the Access Approval settings associated with a project, folder, or organization.

 

   getServiceAccount(name, x__xgafv=None)

 
Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

@@ -102,7 +102,7 @@ 
Method Details

 
 

     deleteAccessApprovalSettings(name, x__xgafv=None)
-  
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
+  
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.
 
 Args:
   name: string, Name of the AccessApprovalSettings to delete. (required)
@@ -120,7 +120,7 @@ 
Method Details

 
 

     getAccessApprovalSettings(name, x__xgafv=None)
-  
Gets the settings associated with a project, folder, or organization.
+  
Gets the Access Approval settings associated with a project, folder, or organization.
 
 Args:
   name: string, The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings" (required)
@@ -135,16 +135,16 @@ 
Method Details

     { # Settings on a Project/Folder/Organization related to Access Approval.
   "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.
   "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).
-  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies.
+  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
-  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.
+  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
   "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).
-  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.
+  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.
     { # Represents the enrollment of a cloud resource into a specific service.
-      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
+      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
       "enrollmentLevel": "A String", # The enrollment level of the service.
     },
   ],
@@ -153,11 +153,11 @@ 
Method Details

   "notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.
     "A String",
   ],
-  "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent.
-  "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.
-  "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.
-  "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request.
-  "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible.
+  "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.
+  "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.
+  "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.
+  "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.
+  "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"
 }

 

 
@@ -193,16 +193,16 @@ 
Method Details

 { # Settings on a Project/Folder/Organization related to Access Approval.
   "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.
   "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).
-  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies.
+  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
-  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.
+  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
   "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).
-  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.
+  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.
     { # Represents the enrollment of a cloud resource into a specific service.
-      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
+      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
       "enrollmentLevel": "A String", # The enrollment level of the service.
     },
   ],
@@ -211,11 +211,11 @@ 
Method Details

   "notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.
     "A String",
   ],
-  "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent.
-  "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.
-  "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.
-  "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request.
-  "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible.
+  "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.
+  "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.
+  "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.
+  "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.
+  "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"
 }
 
   updateMask: string, The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.
@@ -230,16 +230,16 @@ 
Method Details

     { # Settings on a Project/Folder/Organization related to Access Approval.
   "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.
   "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).
-  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies.
+  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
-  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.
+  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
   "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).
-  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.
+  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.
     { # Represents the enrollment of a cloud resource into a specific service.
-      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
+      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
       "enrollmentLevel": "A String", # The enrollment level of the service.
     },
   ],
@@ -248,11 +248,11 @@ 
Method Details

   "notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.
     "A String",
   ],
-  "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent.
-  "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.
-  "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.
-  "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request.
-  "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible.
+  "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.
+  "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.
+  "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.
+  "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.
+  "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"
 }

 

 
diff --git a/docs/dyn/accessapproval_v1.organizations.approvalRequests.html b/docs/dyn/accessapproval_v1.organizations.approvalRequests.html
index 238b94f1198..8dc3699422d 100644
--- a/docs/dyn/accessapproval_v1.organizations.approvalRequests.html
+++ b/docs/dyn/accessapproval_v1.organizations.approvalRequests.html
@@ -82,13 +82,13 @@ 
Instance Methods

 
Close httplib2 connections.

 

   dismiss(name, body=None, x__xgafv=None)

-
Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

+
Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

 

   get(name, x__xgafv=None)

 
Gets an approval request. Returns NOT_FOUND if the request does not exist.

 

   invalidate(name, body=None, x__xgafv=None)

-
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

+
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

 

   list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

 
Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

@@ -138,18 +138,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -165,7 +165,7 @@ 
Method Details

 
 

     dismiss(name, body=None, x__xgafv=None)
-  
Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
+  
Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
 
 Args:
   name: string, Name of the ApprovalRequest to dismiss. (required)
@@ -204,18 +204,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -259,18 +259,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -281,7 +281,7 @@ 
Method Details

 
 

     invalidate(name, body=None, x__xgafv=None)
-  
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
+  
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
 
 Args:
   name: string, Name of the ApprovalRequest to invalidate. (required)
@@ -320,18 +320,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -380,18 +380,18 @@ 
Method Details

       },
       "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
       "requestTime": "A String", # The time at which approval was requested.
-      "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+      "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
         "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
       },
       "requestedDuration": "A String", # The requested access duration.
       "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-      "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-        "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-        "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+      "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+        "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+        "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
       },
-      "requestedReason": { # The justification for which approval is being requested.
+      "requestedReason": { # The access reason for which approval is being requested.
         "detail": "A String", # More detail about certain reason types. See comments for each type above.
-        "type": "A String", # Type of access justification.
+        "type": "A String", # Type of access reason.
       },
       "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
       "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
diff --git a/docs/dyn/accessapproval_v1.organizations.html b/docs/dyn/accessapproval_v1.organizations.html
index e8085992560..7c0149972ab 100644
--- a/docs/dyn/accessapproval_v1.organizations.html
+++ b/docs/dyn/accessapproval_v1.organizations.html
@@ -84,10 +84,10 @@ 
Instance Methods

 
Close httplib2 connections.

 

   deleteAccessApprovalSettings(name, x__xgafv=None)

-
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

+
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.

 

   getAccessApprovalSettings(name, x__xgafv=None)

-
Gets the settings associated with a project, folder, or organization.

+
Gets the Access Approval settings associated with a project, folder, or organization.

 

   getServiceAccount(name, x__xgafv=None)

 
Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

@@ -102,7 +102,7 @@ 
Method Details

 
 

     deleteAccessApprovalSettings(name, x__xgafv=None)
-  
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
+  
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.
 
 Args:
   name: string, Name of the AccessApprovalSettings to delete. (required)
@@ -120,7 +120,7 @@ 
Method Details

 
 

     getAccessApprovalSettings(name, x__xgafv=None)
-  
Gets the settings associated with a project, folder, or organization.
+  
Gets the Access Approval settings associated with a project, folder, or organization.
 
 Args:
   name: string, The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings" (required)
@@ -135,16 +135,16 @@ 
Method Details

     { # Settings on a Project/Folder/Organization related to Access Approval.
   "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.
   "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).
-  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies.
+  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
-  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.
+  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
   "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).
-  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.
+  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.
     { # Represents the enrollment of a cloud resource into a specific service.
-      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
+      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
       "enrollmentLevel": "A String", # The enrollment level of the service.
     },
   ],
@@ -153,11 +153,11 @@ 
Method Details

   "notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.
     "A String",
   ],
-  "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent.
-  "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.
-  "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.
-  "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request.
-  "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible.
+  "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.
+  "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.
+  "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.
+  "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.
+  "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"
 }

 

 
@@ -193,16 +193,16 @@ 
Method Details

 { # Settings on a Project/Folder/Organization related to Access Approval.
   "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.
   "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).
-  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies.
+  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
-  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.
+  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
   "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).
-  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.
+  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.
     { # Represents the enrollment of a cloud resource into a specific service.
-      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
+      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
       "enrollmentLevel": "A String", # The enrollment level of the service.
     },
   ],
@@ -211,11 +211,11 @@ 
Method Details

   "notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.
     "A String",
   ],
-  "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent.
-  "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.
-  "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.
-  "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request.
-  "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible.
+  "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.
+  "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.
+  "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.
+  "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.
+  "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"
 }
 
   updateMask: string, The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.
@@ -230,16 +230,16 @@ 
Method Details

     { # Settings on a Project/Folder/Organization related to Access Approval.
   "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.
   "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).
-  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies.
+  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
-  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.
+  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
   "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).
-  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.
+  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.
     { # Represents the enrollment of a cloud resource into a specific service.
-      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
+      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
       "enrollmentLevel": "A String", # The enrollment level of the service.
     },
   ],
@@ -248,11 +248,11 @@ 
Method Details

   "notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.
     "A String",
   ],
-  "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent.
-  "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.
-  "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.
-  "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request.
-  "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible.
+  "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.
+  "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.
+  "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.
+  "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.
+  "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"
 }

 

 
diff --git a/docs/dyn/accessapproval_v1.projects.approvalRequests.html b/docs/dyn/accessapproval_v1.projects.approvalRequests.html
index 5ae7f1ec70f..7e4153626bd 100644
--- a/docs/dyn/accessapproval_v1.projects.approvalRequests.html
+++ b/docs/dyn/accessapproval_v1.projects.approvalRequests.html
@@ -82,13 +82,13 @@ 
Instance Methods

 
Close httplib2 connections.

 

   dismiss(name, body=None, x__xgafv=None)

-
Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

+
Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

 

   get(name, x__xgafv=None)

 
Gets an approval request. Returns NOT_FOUND if the request does not exist.

 

   invalidate(name, body=None, x__xgafv=None)

-
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

+
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

 

   list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

 
Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

@@ -138,18 +138,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -165,7 +165,7 @@ 
Method Details

 
 

     dismiss(name, body=None, x__xgafv=None)
-  
Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
+  
Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
 
 Args:
   name: string, Name of the ApprovalRequest to dismiss. (required)
@@ -204,18 +204,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -259,18 +259,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -281,7 +281,7 @@ 
Method Details

 
 

     invalidate(name, body=None, x__xgafv=None)
-  
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
+  
Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
 
 Args:
   name: string, Name of the ApprovalRequest to invalidate. (required)
@@ -320,18 +320,18 @@ 
Method Details

   },
   "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
   "requestTime": "A String", # The time at which approval was requested.
-  "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+  "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
     "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
   },
   "requestedDuration": "A String", # The requested access duration.
   "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-  "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-    "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-    "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+  "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+    "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+    "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
   },
-  "requestedReason": { # The justification for which approval is being requested.
+  "requestedReason": { # The access reason for which approval is being requested.
     "detail": "A String", # More detail about certain reason types. See comments for each type above.
-    "type": "A String", # Type of access justification.
+    "type": "A String", # Type of access reason.
   },
   "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
   "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
@@ -380,18 +380,18 @@ 
Method Details

       },
       "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}".
       "requestTime": "A String", # The time at which approval was requested.
-      "requestedAugmentedInfo": { # This field contains the augmented information of the request. # This field contains the augmented information of the request.
+      "requestedAugmentedInfo": { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
         "command": "A String", # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
       },
       "requestedDuration": "A String", # The requested access duration.
       "requestedExpiration": "A String", # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
-      "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
-        "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
-        "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+      "requestedLocations": { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
+        "principalOfficeCountry": "A String", # The "home office" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
+        "principalPhysicalLocationCountry": "A String", # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
       },
-      "requestedReason": { # The justification for which approval is being requested.
+      "requestedReason": { # The access reason for which approval is being requested.
         "detail": "A String", # More detail about certain reason types. See comments for each type above.
-        "type": "A String", # Type of access justification.
+        "type": "A String", # Type of access reason.
       },
       "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification.
       "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
diff --git a/docs/dyn/accessapproval_v1.projects.html b/docs/dyn/accessapproval_v1.projects.html
index 01775395164..9002cca121e 100644
--- a/docs/dyn/accessapproval_v1.projects.html
+++ b/docs/dyn/accessapproval_v1.projects.html
@@ -84,10 +84,10 @@ 
Instance Methods

 
Close httplib2 connections.

 

   deleteAccessApprovalSettings(name, x__xgafv=None)

-
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

+
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.

 

   getAccessApprovalSettings(name, x__xgafv=None)

-
Gets the settings associated with a project, folder, or organization.

+
Gets the Access Approval settings associated with a project, folder, or organization.

 

   getServiceAccount(name, x__xgafv=None)

 
Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

@@ -102,7 +102,7 @@ 
Method Details

 
 

     deleteAccessApprovalSettings(name, x__xgafv=None)
-  
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.
+  
Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.
 
 Args:
   name: string, Name of the AccessApprovalSettings to delete. (required)
@@ -120,7 +120,7 @@ 
Method Details

 
 

     getAccessApprovalSettings(name, x__xgafv=None)
-  
Gets the settings associated with a project, folder, or organization.
+  
Gets the Access Approval settings associated with a project, folder, or organization.
 
 Args:
   name: string, The name of the AccessApprovalSettings to retrieve. Format: "{projects|folders|organizations}/{id}/accessApprovalSettings" (required)
@@ -135,16 +135,16 @@ 
Method Details

     { # Settings on a Project/Folder/Organization related to Access Approval.
   "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.
   "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).
-  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies.
+  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
-  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.
+  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
   "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).
-  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.
+  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.
     { # Represents the enrollment of a cloud resource into a specific service.
-      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
+      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
       "enrollmentLevel": "A String", # The enrollment level of the service.
     },
   ],
@@ -153,11 +153,11 @@ 
Method Details

   "notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.
     "A String",
   ],
-  "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent.
-  "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.
-  "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.
-  "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request.
-  "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible.
+  "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.
+  "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.
+  "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.
+  "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.
+  "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"
 }

 

 
@@ -193,16 +193,16 @@ 
Method Details

 { # Settings on a Project/Folder/Organization related to Access Approval.
   "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.
   "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).
-  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies.
+  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
-  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.
+  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
   "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).
-  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.
+  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.
     { # Represents the enrollment of a cloud resource into a specific service.
-      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
+      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
       "enrollmentLevel": "A String", # The enrollment level of the service.
     },
   ],
@@ -211,11 +211,11 @@ 
Method Details

   "notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.
     "A String",
   ],
-  "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent.
-  "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.
-  "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.
-  "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request.
-  "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible.
+  "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.
+  "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.
+  "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.
+  "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.
+  "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"
 }
 
   updateMask: string, The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated.
@@ -230,16 +230,16 @@ 
Method Details

     { # Settings on a Project/Folder/Organization related to Access Approval.
   "activeKeyVersion": "A String", # The asymmetric crypto key version to use for signing approval requests. Empty active_key_version indicates that a Google-managed key should be used for signing. This property will be ignored if set by an ancestor of this resource, and new non-empty values may not be set.
   "ancestorHasActiveKeyVersion": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that an ancestor of this Project or Folder has set active_key_version (this field will always be unset for the organization since organizations do not have ancestors).
-  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy for approval. This contains all policies.
+  "approvalPolicy": { # Represents all the policies that can be set for Customer Approval. # Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
-  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.
+  "effectiveApprovalPolicy": { # Represents all the policies that can be set for Customer Approval. # Output only. Effective policy applied for Access Approval, inclusive of inheritance.
     "justificationBasedApprovalPolicy": "A String", # Optional. Policy for approval based on the justification given.
   },
   "enrolledAncestor": True or False, # Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors).
-  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.
+  "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.
     { # Represents the enrollment of a cloud resource into a specific service.
-      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
+      "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services
       "enrollmentLevel": "A String", # The enrollment level of the service.
     },
   ],
@@ -248,11 +248,11 @@ 
Method Details

   "notificationEmails": [ # A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed.
     "A String",
   ],
-  "notificationPubsubTopic": "A String", # Optional. A pubsub topic to which notifications relating to approval requests should be sent.
-  "preferNoBroadApprovalRequests": True or False, # This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.
-  "preferredRequestExpirationDays": 42, # This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.
-  "requestScopeMaxWidthPreference": "A String", # Optional. A setting to indicate the maximum width of an Access Approval request.
-  "requireCustomerVisibleJustification": True or False, # Optional. A setting to require approval request justifications to be customer visible.
+  "notificationPubsubTopic": "A String", # Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.
+  "preferNoBroadApprovalRequests": True or False, # This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.
+  "preferredRequestExpirationDays": 42, # Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.
+  "requestScopeMaxWidthPreference": "A String", # Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.
+  "requireCustomerVisibleJustification": True or False, # Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as "Require customer initiated support case justification"
 }

 

 
diff --git a/docs/dyn/admin_directory_v1.chromeosdevices.html b/docs/dyn/admin_directory_v1.chromeosdevices.html
index 98b9e5f6444..1a4ba19747a 100644
--- a/docs/dyn/admin_directory_v1.chromeosdevices.html
+++ b/docs/dyn/admin_directory_v1.chromeosdevices.html
@@ -267,7 +267,7 @@ 
Method Details

     "updateTime": "A String", # Date and time of the last successful OS update.
   },
   "osVersion": "A String", # The Chrome device's operating system version.
-  "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
+  "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version.
   "platformVersion": "A String", # The Chrome device's platform version.
   "recentUsers": [ # A list of recent device users, in descending order, by last login time.
     { # A list of recent device users, in descending order, by last login time.
@@ -466,7 +466,7 @@ 
Method Details

         "updateTime": "A String", # Date and time of the last successful OS update.
       },
       "osVersion": "A String", # The Chrome device's operating system version.
-      "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
+      "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version.
       "platformVersion": "A String", # The Chrome device's platform version.
       "recentUsers": [ # A list of recent device users, in descending order, by last login time.
         { # A list of recent device users, in descending order, by last login time.
@@ -680,7 +680,7 @@ 
Method Details

     "updateTime": "A String", # Date and time of the last successful OS update.
   },
   "osVersion": "A String", # The Chrome device's operating system version.
-  "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
+  "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version.
   "platformVersion": "A String", # The Chrome device's platform version.
   "recentUsers": [ # A list of recent device users, in descending order, by last login time.
     { # A list of recent device users, in descending order, by last login time.
@@ -853,7 +853,7 @@ 
Method Details

     "updateTime": "A String", # Date and time of the last successful OS update.
   },
   "osVersion": "A String", # The Chrome device's operating system version.
-  "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
+  "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version.
   "platformVersion": "A String", # The Chrome device's platform version.
   "recentUsers": [ # A list of recent device users, in descending order, by last login time.
     { # A list of recent device users, in descending order, by last login time.
@@ -1025,7 +1025,7 @@ 
Method Details

     "updateTime": "A String", # Date and time of the last successful OS update.
   },
   "osVersion": "A String", # The Chrome device's operating system version.
-  "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
+  "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version.
   "platformVersion": "A String", # The Chrome device's platform version.
   "recentUsers": [ # A list of recent device users, in descending order, by last login time.
     { # A list of recent device users, in descending order, by last login time.
@@ -1198,7 +1198,7 @@ 
Method Details

     "updateTime": "A String", # Date and time of the last successful OS update.
   },
   "osVersion": "A String", # The Chrome device's operating system version.
-  "osVersionCompliance": "A String", # Output only. Compliance status of the OS version.
+  "osVersionCompliance": "A String", # Output only. Device policy compliance status of the OS version.
   "platformVersion": "A String", # The Chrome device's platform version.
   "recentUsers": [ # A list of recent device users, in descending order, by last login time.
     { # A list of recent device users, in descending order, by last login time.
diff --git a/docs/dyn/admin_directory_v1.groups.html b/docs/dyn/admin_directory_v1.groups.html
index 6bbba94b019..c16965f6762 100644
--- a/docs/dyn/admin_directory_v1.groups.html
+++ b/docs/dyn/admin_directory_v1.groups.html
@@ -217,7 +217,7 @@ 
Method Details

     Allowed values
       email - Email of the group.
   pageToken: string, Token to specify next page in the list
-  query: string, Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
+  query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-groups
   sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
     Allowed values
       ASCENDING - Ascending order.
diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html
index 62dd8f2b755..ce8adf1701e 100644
--- a/docs/dyn/admin_directory_v1.users.html
+++ b/docs/dyn/admin_directory_v1.users.html
@@ -880,7 +880,7 @@ 
Method Details

       basic - Do not include any custom fields for the user.
       custom - Include custom fields from schemas mentioned in customFieldMask.
       full - Include all fields associated with this user.
-  query: string, Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users
+  query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-users
   showDeleted: string, If set to true, retrieves the list of deleted users. (Default: false)
   sortOrder: string, Whether to return results in ascending or descending order.
     Allowed values
diff --git a/docs/dyn/apigateway_v1.projects.locations.html b/docs/dyn/apigateway_v1.projects.locations.html
index 132185865e9..bca7d8e3578 100644
--- a/docs/dyn/apigateway_v1.projects.locations.html
+++ b/docs/dyn/apigateway_v1.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/apigateway_v1beta.projects.locations.html b/docs/dyn/apigateway_v1beta.projects.locations.html
index 7cacab5f468..e317abbeb52 100644
--- a/docs/dyn/apigateway_v1beta.projects.locations.html
+++ b/docs/dyn/apigateway_v1beta.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/apim_v1alpha.projects.locations.html b/docs/dyn/apim_v1alpha.projects.locations.html
index cbc5b397bad..d13dcafe115 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.html
@@ -172,7 +172,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/backupdr_v1.projects.locations.html b/docs/dyn/backupdr_v1.projects.locations.html
index ece1123bbfd..e0dd4d739c3 100644
--- a/docs/dyn/backupdr_v1.projects.locations.html
+++ b/docs/dyn/backupdr_v1.projects.locations.html
@@ -196,7 +196,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/beyondcorp_v1.projects.locations.html b/docs/dyn/beyondcorp_v1.projects.locations.html
index 841dad0f412..0ab68f270d3 100644
--- a/docs/dyn/beyondcorp_v1.projects.locations.html
+++ b/docs/dyn/beyondcorp_v1.projects.locations.html
@@ -150,7 +150,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.html
index e82e11c5fb1..638ffe8d97c 100644
--- a/docs/dyn/beyondcorp_v1alpha.projects.locations.html
+++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.html
@@ -175,7 +175,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/certificatemanager_v1.projects.locations.html b/docs/dyn/certificatemanager_v1.projects.locations.html
index c5a99c8e2f8..5d084db1cfb 100644
--- a/docs/dyn/certificatemanager_v1.projects.locations.html
+++ b/docs/dyn/certificatemanager_v1.projects.locations.html
@@ -155,7 +155,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/clouddeploy_v1.projects.locations.html b/docs/dyn/clouddeploy_v1.projects.locations.html
index 99f2b5e0e72..e10103193bc 100644
--- a/docs/dyn/clouddeploy_v1.projects.locations.html
+++ b/docs/dyn/clouddeploy_v1.projects.locations.html
@@ -185,7 +185,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/config_v1.projects.locations.html b/docs/dyn/config_v1.projects.locations.html
index 8a3fd5ce69e..cbda2afda42 100644
--- a/docs/dyn/config_v1.projects.locations.html
+++ b/docs/dyn/config_v1.projects.locations.html
@@ -145,7 +145,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html
index 4d0dafc7503..c3c1ffb7ba5 100644
--- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html
+++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html
@@ -85,10 +85,10 @@ 
Instance Methods

 
Deletes an Entry.

 

   get(name, aspectTypes=None, paths=None, view=None, x__xgafv=None)

-
Gets an Entry.

+
Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).

 

   list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-
Lists Entries within an EntryGroup.

+
Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).

 

   list_next()

 
Retrieves the next page of results.

@@ -269,7 +269,7 @@ 
Method Details

 
 

     get(name, aspectTypes=None, paths=None, view=None, x__xgafv=None)
-  
Gets an Entry.
+  
Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).
 
 Args:
   name: string, Required. The resource name of the Entry: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. (required)
@@ -337,7 +337,7 @@ 
Method Details

 
 

     list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-  
Lists Entries within an EntryGroup.
+  
Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).
 
 Args:
   parent: string, Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}. (required)
diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html
index e167f9dbfa2..82aff3696fe 100644
--- a/docs/dyn/dataplex_v1.projects.locations.html
+++ b/docs/dyn/dataplex_v1.projects.locations.html
@@ -153,7 +153,7 @@ 
Instance Methods

 
Retrieves the next page of results.

 

   lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)

-
Looks up an entry by name using the permission on the source system.

+
Looks up an entry by name using the permission on the source system. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).

 

   searchEntries(name, orderBy=None, pageSize=None, pageToken=None, query=None, scope=None, semanticSearch=None, x__xgafv=None)

 
Searches for Entries matching the given query and scope.

@@ -245,7 +245,7 @@ 
Method Details

 
 

     lookupEntry(name, aspectTypes=None, entry=None, paths=None, view=None, x__xgafv=None)
-  
Looks up an entry by name using the permission on the source system.
+  
Looks up an entry by name using the permission on the source system. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).
 
 Args:
   name: string, Required. The project to which the request should be attributed in the following form: projects/{project}/locations/{location}. (required)
diff --git a/docs/dyn/dataplex_v1.projects.locations.metadataJobs.html b/docs/dyn/dataplex_v1.projects.locations.metadataJobs.html
index c4d68801634..81618bd743c 100644
--- a/docs/dyn/dataplex_v1.projects.locations.metadataJobs.html
+++ b/docs/dyn/dataplex_v1.projects.locations.metadataJobs.html
@@ -174,7 +174,7 @@ 
Method Details

       "aspectTypes": [ # Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.This field is required when creating an aspect-only import job.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.
         "A String",
       ],
-      "entryGroups": [ # Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.
+      "entryGroups": [ # Required. The entry groups that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry groups are affected by the job.The entry groups and the job must be in the same location.
         "A String",
       ],
       "entryLinkTypes": [ # Optional. The entry link types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}. The job modifies only the entryLinks that belong to these entry link types.If the metadata import file attempts to create or delete an entry link whose entry link type isn't included in this list, the import job will skip those entry links.
@@ -296,7 +296,7 @@ 
Method Details

       "aspectTypes": [ # Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.This field is required when creating an aspect-only import job.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.
         "A String",
       ],
-      "entryGroups": [ # Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.
+      "entryGroups": [ # Required. The entry groups that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry groups are affected by the job.The entry groups and the job must be in the same location.
         "A String",
       ],
       "entryLinkTypes": [ # Optional. The entry link types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}. The job modifies only the entryLinks that belong to these entry link types.If the metadata import file attempts to create or delete an entry link whose entry link type isn't included in this list, the import job will skip those entry links.
@@ -394,7 +394,7 @@ 
Method Details

           "aspectTypes": [ # Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.This field is required when creating an aspect-only import job.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.
             "A String",
           ],
-          "entryGroups": [ # Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.
+          "entryGroups": [ # Required. The entry groups that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry groups are affected by the job.The entry groups and the job must be in the same location.
             "A String",
           ],
           "entryLinkTypes": [ # Optional. The entry link types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryLinkTypes/{entry_link_type_id}. The job modifies only the entryLinks that belong to these entry link types.If the metadata import file attempts to create or delete an entry link whose entry link type isn't included in this list, the import job will skip those entry links.
diff --git a/docs/dyn/drive_v3.accessproposals.html b/docs/dyn/drive_v3.accessproposals.html
index dbc5f5a1a97..6be7f0357df 100644
--- a/docs/dyn/drive_v3.accessproposals.html
+++ b/docs/dyn/drive_v3.accessproposals.html
@@ -79,16 +79,16 @@ 
Instance Methods

 
Close httplib2 connections.

 

   get(fileId, proposalId, x__xgafv=None)

-
Retrieves an AccessProposal by ID.

+
Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).

 

   list(fileId, pageSize=None, pageToken=None, x__xgafv=None)

-
List the AccessProposals on a file. Note: Only approvers are able to list AccessProposals on a file. If the user is not an approver, returns a 403.

+
List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.

 

   list_next()

 
Retrieves the next page of results.

 

   resolve(fileId, proposalId, body=None, x__xgafv=None)

-
Used to approve or deny an Access Proposal.

+
Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).

 
Method Details

 

     close()
@@ -97,11 +97,11 @@ 
Method Details

 
 

     get(fileId, proposalId, x__xgafv=None)
-  
Retrieves an AccessProposal by ID.
+  
Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).
 
 Args:
-  fileId: string, Required. The id of the item the request is on. (required)
-  proposalId: string, Required. The id of the access proposal to resolve. (required)
+  fileId: string, Required. The ID of the item the request is on. (required)
+  proposalId: string, Required. The ID of the access proposal to resolve. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -110,17 +110,17 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # The Access Proposal resource for outstanding access proposals on a file
-  "createTime": "A String", # The creation time
-  "fileId": "A String", # The file id that the proposal for access is on
-  "proposalId": "A String", # The id of the access proposal
-  "recipientEmailAddress": "A String", # The email address of the user that will receive permissions if accepted
-  "requestMessage": "A String", # The message that the requester added to the proposal
-  "requesterEmailAddress": "A String", # The email address of the requesting user
-  "rolesAndViews": [ # A wrapper for the role and view of an access proposal.
-    { # A wrapper for the role and view of an access proposal.
-      "role": "A String", # The role that was proposed by the requester New values may be added in the future, but the following are currently possible: * `writer` * `commenter` * `reader`
-      "view": "A String", # Indicates the view for this access proposal. Only populated for proposals that belong to a view. `published` is the only supported value.
+    { # Manage outstanding access proposals on a file.
+  "createTime": "A String", # The creation time.
+  "fileId": "A String", # The file ID that the proposal for access is on.
+  "proposalId": "A String", # The ID of the access proposal.
+  "recipientEmailAddress": "A String", # The email address of the user that will receive permissions, if accepted.
+  "requestMessage": "A String", # The message that the requester added to the proposal.
+  "requesterEmailAddress": "A String", # The email address of the requesting user.
+  "rolesAndViews": [ # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
+    { # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
+      "role": "A String", # The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`
+      "view": "A String", # Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.
     },
   ],
 }

@@ -128,11 +128,11 @@ 
Method Details

 
 

     list(fileId, pageSize=None, pageToken=None, x__xgafv=None)
-  
List the AccessProposals on a file. Note: Only approvers are able to list AccessProposals on a file. If the user is not an approver, returns a 403.
+  
List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.
 
 Args:
-  fileId: string, Required. The id of the item the request is on. (required)
-  pageSize: integer, Optional. The number of results per page
+  fileId: string, Required. The ID of the item the request is on. (required)
+  pageSize: integer, Optional. The number of results per page.
   pageToken: string, Optional. The continuation token on the list of access requests.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -142,19 +142,19 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # The response to an Access Proposal list request.
-  "accessProposals": [ # The list of Access Proposals. This field is only populated in v3 and v3beta.
-    { # The Access Proposal resource for outstanding access proposals on a file
-      "createTime": "A String", # The creation time
-      "fileId": "A String", # The file id that the proposal for access is on
-      "proposalId": "A String", # The id of the access proposal
-      "recipientEmailAddress": "A String", # The email address of the user that will receive permissions if accepted
-      "requestMessage": "A String", # The message that the requester added to the proposal
-      "requesterEmailAddress": "A String", # The email address of the requesting user
-      "rolesAndViews": [ # A wrapper for the role and view of an access proposal.
-        { # A wrapper for the role and view of an access proposal.
-          "role": "A String", # The role that was proposed by the requester New values may be added in the future, but the following are currently possible: * `writer` * `commenter` * `reader`
-          "view": "A String", # Indicates the view for this access proposal. Only populated for proposals that belong to a view. `published` is the only supported value.
+    { # The response to an access proposal list request.
+  "accessProposals": [ # The list of access proposals. This field is only populated in Drive API v3.
+    { # Manage outstanding access proposals on a file.
+      "createTime": "A String", # The creation time.
+      "fileId": "A String", # The file ID that the proposal for access is on.
+      "proposalId": "A String", # The ID of the access proposal.
+      "recipientEmailAddress": "A String", # The email address of the user that will receive permissions, if accepted.
+      "requestMessage": "A String", # The message that the requester added to the proposal.
+      "requesterEmailAddress": "A String", # The email address of the requesting user.
+      "rolesAndViews": [ # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
+        { # A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
+          "role": "A String", # The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`
+          "view": "A String", # Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.
         },
       ],
     },
@@ -179,21 +179,21 @@ 
Method Details

 
 

     resolve(fileId, proposalId, body=None, x__xgafv=None)
-  
Used to approve or deny an Access Proposal.
+  
Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).
 
 Args:
-  fileId: string, Required. The id of the item the request is on. (required)
-  proposalId: string, Required. The id of the access proposal to resolve. (required)
+  fileId: string, Required. The ID of the item the request is on. (required)
+  proposalId: string, Required. The ID of the access proposal to resolve. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for resolving an AccessProposal on a file.
-  "action": "A String", # Required. The action to take on the AccessProposal.
-  "role": [ # Optional. The roles the approver has allowed, if any. Note: This field is required for the `ACCEPT` action.
+  "action": "A String", # Required. The action to take on the access proposal.
+  "role": [ # Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action.
     "A String",
   ],
-  "sendNotification": True or False, # Optional. Whether to send an email to the requester when the AccessProposal is denied or accepted.
-  "view": "A String", # Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. `published` is the only supported value.
+  "sendNotification": True or False, # Optional. Whether to send an email to the requester when the access proposal is denied or accepted.
+  "view": "A String", # Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported.
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/file_v1.projects.locations.html b/docs/dyn/file_v1.projects.locations.html
index 123c237faa4..510a728cf16 100644
--- a/docs/dyn/file_v1.projects.locations.html
+++ b/docs/dyn/file_v1.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/file_v1beta1.projects.locations.html b/docs/dyn/file_v1beta1.projects.locations.html
index 4eaf1de9e90..9658f86dde1 100644
--- a/docs/dyn/file_v1beta1.projects.locations.html
+++ b/docs/dyn/file_v1beta1.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/firestore_v1.projects.locations.html b/docs/dyn/firestore_v1.projects.locations.html
index 90230bdeb9a..d4dd57c7115 100644
--- a/docs/dyn/firestore_v1.projects.locations.html
+++ b/docs/dyn/firestore_v1.projects.locations.html
@@ -130,7 +130,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/looker_v1.projects.locations.html b/docs/dyn/looker_v1.projects.locations.html
index 3fca5fa4e92..46e53fcde82 100644
--- a/docs/dyn/looker_v1.projects.locations.html
+++ b/docs/dyn/looker_v1.projects.locations.html
@@ -135,7 +135,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/managedkafka_v1.projects.locations.html b/docs/dyn/managedkafka_v1.projects.locations.html
index be0142ac800..9576165a785 100644
--- a/docs/dyn/managedkafka_v1.projects.locations.html
+++ b/docs/dyn/managedkafka_v1.projects.locations.html
@@ -145,7 +145,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/metastore_v1.projects.locations.html b/docs/dyn/metastore_v1.projects.locations.html
index a5314c81db6..eae51ccb0a7 100644
--- a/docs/dyn/metastore_v1.projects.locations.html
+++ b/docs/dyn/metastore_v1.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/metastore_v1alpha.projects.locations.html b/docs/dyn/metastore_v1alpha.projects.locations.html
index 2e0c4601efd..551fe6e0704 100644
--- a/docs/dyn/metastore_v1alpha.projects.locations.html
+++ b/docs/dyn/metastore_v1alpha.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/metastore_v1beta.projects.locations.html b/docs/dyn/metastore_v1beta.projects.locations.html
index b0d5fac24e1..93b159e7331 100644
--- a/docs/dyn/metastore_v1beta.projects.locations.html
+++ b/docs/dyn/metastore_v1beta.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/parallelstore_v1.projects.locations.html b/docs/dyn/parallelstore_v1.projects.locations.html
index 5860fcc61d3..edd44367443 100644
--- a/docs/dyn/parallelstore_v1.projects.locations.html
+++ b/docs/dyn/parallelstore_v1.projects.locations.html
@@ -135,7 +135,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/parallelstore_v1beta.projects.locations.html b/docs/dyn/parallelstore_v1beta.projects.locations.html
index cadd6a9949d..a688691f5ef 100644
--- a/docs/dyn/parallelstore_v1beta.projects.locations.html
+++ b/docs/dyn/parallelstore_v1beta.projects.locations.html
@@ -135,7 +135,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/parametermanager_v1.projects.locations.html b/docs/dyn/parametermanager_v1.projects.locations.html
index 246e35cbc37..91f009ad179 100644
--- a/docs/dyn/parametermanager_v1.projects.locations.html
+++ b/docs/dyn/parametermanager_v1.projects.locations.html
@@ -130,7 +130,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/privateca_v1.projects.locations.html b/docs/dyn/privateca_v1.projects.locations.html
index b8ca782f2f5..abb85a10a2c 100644
--- a/docs/dyn/privateca_v1.projects.locations.html
+++ b/docs/dyn/privateca_v1.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/privateca_v1beta1.projects.locations.html b/docs/dyn/privateca_v1beta1.projects.locations.html
index d13894bdd0b..7dba0d382e4 100644
--- a/docs/dyn/privateca_v1beta1.projects.locations.html
+++ b/docs/dyn/privateca_v1beta1.projects.locations.html
@@ -140,7 +140,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html
index 057fd7f81e6..08d13e66f9c 100644
--- a/docs/dyn/run_v1.namespaces.jobs.html
+++ b/docs/dyn/run_v1.namespaces.jobs.html
@@ -840,7 +840,7 @@ 
Method Details

   
Get information about a job.
 
 Args:
-  name: string, Required. The name of the job to retrieve. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID (required)
+  name: string, Required. The name of the job to retrieve. It takes the form namespaces/{namespace}/jobs/{job_name} and the `endpoint` must be regional. Replace {namespace} with the project ID or number. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html
index 134ae16391d..0735e31f132 100644
--- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html
+++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.html
@@ -165,7 +165,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/secretmanager_v1.projects.locations.html b/docs/dyn/secretmanager_v1.projects.locations.html
index ae3d786a0ae..935214cb064 100644
--- a/docs/dyn/secretmanager_v1.projects.locations.html
+++ b/docs/dyn/secretmanager_v1.projects.locations.html
@@ -130,7 +130,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/secretmanager_v1beta1.projects.locations.html b/docs/dyn/secretmanager_v1beta1.projects.locations.html
index c2b45960207..6482ff9bd93 100644
--- a/docs/dyn/secretmanager_v1beta1.projects.locations.html
+++ b/docs/dyn/secretmanager_v1beta1.projects.locations.html
@@ -125,7 +125,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/secretmanager_v1beta2.projects.locations.html b/docs/dyn/secretmanager_v1beta2.projects.locations.html
index 249941740e9..604f87e80dd 100644
--- a/docs/dyn/secretmanager_v1beta2.projects.locations.html
+++ b/docs/dyn/secretmanager_v1beta2.projects.locations.html
@@ -130,7 +130,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/servicedirectory_v1.projects.locations.html b/docs/dyn/servicedirectory_v1.projects.locations.html
index 4a32641b3d1..9b1c0d3e6d3 100644
--- a/docs/dyn/servicedirectory_v1.projects.locations.html
+++ b/docs/dyn/servicedirectory_v1.projects.locations.html
@@ -130,7 +130,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/servicedirectory_v1beta1.projects.locations.html b/docs/dyn/servicedirectory_v1beta1.projects.locations.html
index bd19abd5fae..a62dc9511d3 100644
--- a/docs/dyn/servicedirectory_v1beta1.projects.locations.html
+++ b/docs/dyn/servicedirectory_v1beta1.projects.locations.html
@@ -130,7 +130,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/storagebatchoperations_v1.projects.locations.html b/docs/dyn/storagebatchoperations_v1.projects.locations.html
index 39c7c401649..1b2ce155c0f 100644
--- a/docs/dyn/storagebatchoperations_v1.projects.locations.html
+++ b/docs/dyn/storagebatchoperations_v1.projects.locations.html
@@ -135,7 +135,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/texttospeech_v1.projects.locations.html b/docs/dyn/texttospeech_v1.projects.locations.html
index 6d5e1947272..98f300b2c29 100644
--- a/docs/dyn/texttospeech_v1.projects.locations.html
+++ b/docs/dyn/texttospeech_v1.projects.locations.html
@@ -130,7 +130,7 @@ 
Method Details

         },
       ],
     },
-    "prompt": "A String", # This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions.
+    "prompt": "A String", # This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions.
     "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
     "text": "A String", # The raw text to be synthesized.
   },
diff --git a/docs/dyn/texttospeech_v1.text.html b/docs/dyn/texttospeech_v1.text.html
index d210a3e8610..102511ae81c 100644
--- a/docs/dyn/texttospeech_v1.text.html
+++ b/docs/dyn/texttospeech_v1.text.html
@@ -127,7 +127,7 @@ 
Method Details

         },
       ],
     },
-    "prompt": "A String", # This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions.
+    "prompt": "A String", # This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions.
     "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
     "text": "A String", # The raw text to be synthesized.
   },
diff --git a/docs/dyn/texttospeech_v1beta1.projects.locations.html b/docs/dyn/texttospeech_v1beta1.projects.locations.html
index 24110abfe0c..68ef1a362b6 100644
--- a/docs/dyn/texttospeech_v1beta1.projects.locations.html
+++ b/docs/dyn/texttospeech_v1beta1.projects.locations.html
@@ -130,7 +130,7 @@ 
Method Details

         },
       ],
     },
-    "prompt": "A String", # This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions.
+    "prompt": "A String", # This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions.
     "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
     "text": "A String", # The raw text to be synthesized.
   },
diff --git a/docs/dyn/texttospeech_v1beta1.text.html b/docs/dyn/texttospeech_v1beta1.text.html
index f3012ab181b..c87ddb2ffa5 100644
--- a/docs/dyn/texttospeech_v1beta1.text.html
+++ b/docs/dyn/texttospeech_v1beta1.text.html
@@ -130,7 +130,7 @@ 
Method Details

         },
       ],
     },
-    "prompt": "A String", # This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions.
+    "prompt": "A String", # This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions.
     "ssml": "A String", # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
     "text": "A String", # The raw text to be synthesized.
   },
diff --git a/docs/dyn/vpcaccess_v1.projects.locations.html b/docs/dyn/vpcaccess_v1.projects.locations.html
index c00e926ecf7..1c68e12981a 100644
--- a/docs/dyn/vpcaccess_v1.projects.locations.html
+++ b/docs/dyn/vpcaccess_v1.projects.locations.html
@@ -105,7 +105,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/vpcaccess_v1beta1.projects.locations.html b/docs/dyn/vpcaccess_v1beta1.projects.locations.html
index eddd0bbb6bc..2b9112cf9ef 100644
--- a/docs/dyn/vpcaccess_v1beta1.projects.locations.html
+++ b/docs/dyn/vpcaccess_v1beta1.projects.locations.html
@@ -105,7 +105,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/workstations_v1.projects.locations.html b/docs/dyn/workstations_v1.projects.locations.html
index 890becd21a1..68ac795b395 100644
--- a/docs/dyn/workstations_v1.projects.locations.html
+++ b/docs/dyn/workstations_v1.projects.locations.html
@@ -135,7 +135,7 @@ 
Method Details

 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/googleapiclient/discovery_cache/documents/accessapproval.v1.json b/googleapiclient/discovery_cache/documents/accessapproval.v1.json
index d4886ef2a65..0723306a099 100644
--- a/googleapiclient/discovery_cache/documents/accessapproval.v1.json
+++ b/googleapiclient/discovery_cache/documents/accessapproval.v1.json
@@ -108,7 +108,7 @@
 "folders": {
 "methods": {
 "deleteAccessApprovalSettings": {
-"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.",
+"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.",
 "flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
 "httpMethod": "DELETE",
 "id": "accessapproval.folders.deleteAccessApprovalSettings",
@@ -133,7 +133,7 @@
 ]
 },
 "getAccessApprovalSettings": {
-"description": "Gets the settings associated with a project, folder, or organization.",
+"description": "Gets the Access Approval settings associated with a project, folder, or organization.",
 "flatPath": "v1/folders/{foldersId}/accessApprovalSettings",
 "httpMethod": "GET",
 "id": "accessapproval.folders.getAccessApprovalSettings",
@@ -249,7 +249,7 @@
 ]
 },
 "dismiss": {
-"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
+"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
 "flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:dismiss",
 "httpMethod": "POST",
 "id": "accessapproval.folders.approvalRequests.dismiss",
@@ -302,7 +302,7 @@
 ]
 },
 "invalidate": {
-"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
+"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
 "flatPath": "v1/folders/{foldersId}/approvalRequests/{approvalRequestsId}:invalidate",
 "httpMethod": "POST",
 "id": "accessapproval.folders.approvalRequests.invalidate",
@@ -377,7 +377,7 @@
 "organizations": {
 "methods": {
 "deleteAccessApprovalSettings": {
-"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.",
+"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.",
 "flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
 "httpMethod": "DELETE",
 "id": "accessapproval.organizations.deleteAccessApprovalSettings",
@@ -402,7 +402,7 @@
 ]
 },
 "getAccessApprovalSettings": {
-"description": "Gets the settings associated with a project, folder, or organization.",
+"description": "Gets the Access Approval settings associated with a project, folder, or organization.",
 "flatPath": "v1/organizations/{organizationsId}/accessApprovalSettings",
 "httpMethod": "GET",
 "id": "accessapproval.organizations.getAccessApprovalSettings",
@@ -518,7 +518,7 @@
 ]
 },
 "dismiss": {
-"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
+"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
 "flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:dismiss",
 "httpMethod": "POST",
 "id": "accessapproval.organizations.approvalRequests.dismiss",
@@ -571,7 +571,7 @@
 ]
 },
 "invalidate": {
-"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
+"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
 "flatPath": "v1/organizations/{organizationsId}/approvalRequests/{approvalRequestsId}:invalidate",
 "httpMethod": "POST",
 "id": "accessapproval.organizations.approvalRequests.invalidate",
@@ -646,7 +646,7 @@
 "projects": {
 "methods": {
 "deleteAccessApprovalSettings": {
-"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.",
+"description": "Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the resource. Access Approval may remain active based on parent resource settings. To confirm the effective settings, call GetAccessApprovalSettings and verify effective setting is disabled.",
 "flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
 "httpMethod": "DELETE",
 "id": "accessapproval.projects.deleteAccessApprovalSettings",
@@ -671,7 +671,7 @@
 ]
 },
 "getAccessApprovalSettings": {
-"description": "Gets the settings associated with a project, folder, or organization.",
+"description": "Gets the Access Approval settings associated with a project, folder, or organization.",
 "flatPath": "v1/projects/{projectsId}/accessApprovalSettings",
 "httpMethod": "GET",
 "id": "accessapproval.projects.getAccessApprovalSettings",
@@ -787,7 +787,7 @@
 ]
 },
 "dismiss": {
-"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
+"description": "Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.",
 "flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:dismiss",
 "httpMethod": "POST",
 "id": "accessapproval.projects.approvalRequests.dismiss",
@@ -840,7 +840,7 @@
 ]
 },
 "invalidate": {
-"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
+"description": "Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.",
 "flatPath": "v1/projects/{projectsId}/approvalRequests/{approvalRequestsId}:invalidate",
 "httpMethod": "POST",
 "id": "accessapproval.projects.approvalRequests.invalidate",
@@ -913,7 +913,7 @@
 }
 }
 },
-"revision": "20250728",
+"revision": "20250912",
 "rootUrl": "https://accessapproval.googleapis.com/",
 "schemas": {
 "AccessApprovalServiceAccount": {
@@ -946,11 +946,11 @@
 },
 "approvalPolicy": {
 "$ref": "CustomerApprovalApprovalPolicy",
-"description": "Optional. Policy for approval. This contains all policies."
+"description": "Optional. Policy configuration for Access Approval that sets the operating mode. The available policies are Transparency, Streamlined Support, and Approval Required."
 },
 "effectiveApprovalPolicy": {
 "$ref": "CustomerApprovalApprovalPolicy",
-"description": "Output only. Policy for approval included inherited settings to understand the exact policy applied to this resource. This is a read-only field.",
+"description": "Output only. Effective policy applied for Access Approval, inclusive of inheritance.",
 "readOnly": true
 },
 "enrolledAncestor": {
@@ -959,7 +959,7 @@
 "type": "boolean"
 },
 "enrolledServices": {
-"description": "A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded.",
+"description": "A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded.",
 "items": {
 "$ref": "EnrolledService"
 },
@@ -982,20 +982,20 @@
 "type": "array"
 },
 "notificationPubsubTopic": {
-"description": "Optional. A pubsub topic to which notifications relating to approval requests should be sent.",
+"description": "Optional. A pubsub topic that notifications relating to access approval are published to. Notifications include pre-approved accesses.",
 "type": "string"
 },
 "preferNoBroadApprovalRequests": {
-"description": "This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary.",
+"description": "This field is used to set a preference for granularity of an access approval request. If true, Google personnel will be asked to send resource-level requests when possible. If false, Google personnel will be asked to send requests at the project level.",
 "type": "boolean"
 },
 "preferredRequestExpirationDays": {
-"description": "This preference is shared with Google personnel, but can be overridden if said personnel deems necessary. The approver ultimately can set the expiration at approval time.",
+"description": "Set the default access approval request expiration time. This value is able to be set directly by the customer at the time of approval, overriding this suggested value. We recommend setting this value to 30 days.",
 "format": "int32",
 "type": "integer"
 },
 "requestScopeMaxWidthPreference": {
-"description": "Optional. A setting to indicate the maximum width of an Access Approval request.",
+"description": "Optional. A setting that indicates the maximum scope of an Access Approval request: either organization, folder, or project. Google administrators will be asked to send requests no broader than the configured scope.",
 "enum": [
 "REQUEST_SCOPE_MAX_WIDTH_PREFERENCE_UNSPECIFIED",
 "ORGANIZATION",
@@ -1003,7 +1003,7 @@
 "PROJECT"
 ],
 "enumDescriptions": [
-"Default value for proto, shouldn't be used.",
+"Default value, defaults to ORGANIZATION if not set. This value is not able to be configured by the user, do not use.",
 "This is the widest scope possible. It means the customer has no scope restriction when it comes to Access Approval requests.",
 "Customer allows the scope of Access Approval requests as broad as the Folder level.",
 "Customer allows the scope of Access Approval requests as broad as the Project level."
@@ -1011,22 +1011,22 @@
 "type": "string"
 },
 "requireCustomerVisibleJustification": {
-"description": "Optional. A setting to require approval request justifications to be customer visible.",
+"description": "Optional. When enabled, Google will only be able to send approval requests for access reasons with a customer accessible case ID in the reason detail. Also known as \"Require customer initiated support case justification\"",
 "type": "boolean"
 }
 },
 "type": "object"
 },
 "AccessLocations": {
-"description": "Home office and physical location of the principal.",
+"description": "Physical assigned office and physical location of the Google administrator performing the access.",
 "id": "AccessLocations",
 "properties": {
 "principalOfficeCountry": {
-"description": "The \"home office\" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location",
+"description": "The \"home office\" location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location",
 "type": "string"
 },
 "principalPhysicalLocationCountry": {
-"description": "Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location",
+"description": "Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as \"US\", \"DE\" or \"GB\" or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location",
 "type": "string"
 }
 },
@@ -1040,7 +1040,7 @@
 "type": "string"
 },
 "type": {
-"description": "Type of access justification.",
+"description": "Type of access reason.",
 "enum": [
 "TYPE_UNSPECIFIED",
 "CUSTOMER_INITIATED_SUPPORT",
@@ -1051,7 +1051,7 @@
 "CLOUD_INITIATED_ACCESS"
 ],
 "enumDescriptions": [
-"Default value for proto, shouldn't be used.",
+"This value is not used.",
 "Customer made a request or raised an issue that required the principal to access customer data. `detail` is of the form (\"#####\" is the issue ID): * \"Feedback Report: #####\" * \"Case Number: #####\" * \"Case ID: #####\" * \"E-PIN Reference: #####\" * \"Google-#####\" * \"T-#####\"",
 "The principal accessed customer data in order to diagnose or resolve a suspected issue in services. Often this access is used to confirm that customers are not affected by a suspected service issue or to remediate a reversible system issue.",
 "Google initiated service for security, fraud, abuse, or compliance purposes.",
@@ -1105,7 +1105,7 @@
 },
 "requestedReason": {
 "$ref": "AccessReason",
-"description": "The justification for which approval is being requested."
+"description": "The access reason for which approval is being requested."
 },
 "requestedResourceName": {
 "description": "The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a \"full\" resource name (e.g. \"//library.googleapis.com/shelves/shelf1/books/book2\") or a \"relative\" resource name (e.g. \"shelves/shelf1/books/book2\") as described in the resource name specification.",
@@ -1165,7 +1165,7 @@
 "type": "object"
 },
 "AugmentedInfo": {
-"description": "This field contains the augmented information of the request.",
+"description": "This field contains the augmented information of the request. Requires augmented administrative access to be enabled.",
 "id": "AugmentedInfo",
 "properties": {
 "command": {
@@ -1189,11 +1189,11 @@
 "JUSTIFICATION_BASED_APPROVAL_INHERITED"
 ],
 "enumDescriptions": [
-"Default value for proto.",
-"Instant approval is enabled for all accesses.",
-"Instant approval is enabled for external justifications.",
-"Instant approval is not enabled for any accesses.",
-"Instant approval is inherited from the parent."
+"Default value, defaults to JUSTIFICATION_BASED_APPROVAL_NOT_ENABLED if not set. This value is not able to be configured by the user, do not use.",
+"Audit-only mode. All accesses are pre-approved instantly.",
+"Customer initiated support access reasons are pre-approved instantly. All other accesses require customer approval.",
+"All access approval requests require customer approval. This is the default value if the policy is not set.",
+"Defer configuration to parent settings. This is the default value if the policy is not set and the parent has a value set."
 ],
 "type": "string"
 }
@@ -1233,7 +1233,7 @@
 "id": "EnrolledService",
 "properties": {
 "cloudProduct": {
-"description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * App Engine * Artifact Registry * BigQuery * Certificate Authority Service * Cloud Bigtable * Cloud Key Management Service * Compute Engine * Cloud Composer * Cloud Dataflow * Cloud Dataproc * Cloud DLP * Cloud EKM * Cloud Firestore * Cloud HSM * Cloud Identity and Access Management * Cloud Logging * Cloud NAT * Cloud Pub/Sub * Cloud Spanner * Cloud SQL * Cloud Storage * Eventarc * Google Kubernetes Engine * Organization Policy Serivice * Persistent Disk * Resource Manager * Secret Manager * Speaker ID Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services",
+"description": "The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): * all * GA * Access Context Manager * Anthos Identity Service * AlloyDB for PostgreSQL * Apigee * Application Integration * App Hub * Artifact Registry * Anthos Service Mesh * Access Transparency * BigQuery * Certificate Authority Service * Cloud Bigtable * CCAI Assist and Knowledge * Cloud Dataflow * Cloud Dataproc * CEP Security Gateway * Compliance Evaluation Service * Cloud Firestore * Cloud Healthcare API * Chronicle * Cloud AI Companion Gateway - Titan * Google Cloud Armor * Cloud Asset Inventory * Cloud Asset Search * Cloud Deploy * Cloud DNS * Cloud Latency * Cloud Memorystore for Redis * CloudNet Control * Cloud Riptide * Cloud Tasks * Cloud Trace * Cloud Data Transfer * Cloud Composer * Integration Connectors * Contact Center AI Insights * Cloud Pub/Sub * Cloud Run * Resource Manager * Cloud Spanner * Database Center * Cloud Dataform * Cloud Data Fusion * Dataplex * Dialogflow Customer Experience Edition * Cloud DLP * Document AI * Edge Container * Edge Network * Cloud EKM * Eventarc * Firebase Data Connect * Firebase Rules * App Engine * Cloud Build * Compute Engine * Cloud Functions (2nd Gen) * Cloud Filestore * Cloud Interconnect * Cloud NetApp Volumes * Cloud Storage * Generative AI App Builder * Google Kubernetes Engine * Backup for GKE API * GKE Connect * GKE Hub * Hoverboard * Cloud HSM * Cloud Identity and Access Management * Cloud Identity-Aware Proxy * Infrastructure Manager * Identity Storage Service * Key Access Justifications * Cloud Key Management Service * Cloud Logging * Looker (Google Cloud core) * Looker Studio * Management Hub * Model Armor * Cloud Monitoring * Cloud NAT * Connectivity Hub * External passthrough Network Load Balancer * OIDC One * Organization Policy Service * Org Lifecycle * Persistent Disk * Parameter Manager * Private Services Access * Regional Internal Application Load Balancer * Storage Batch Operations * Cloud Security Command Center * Secure Source Manager * Seeker * Service Provisioning * Speaker ID * Secret Manager * Cloud SQL * Cloud Speech-to-Text * Traffic Director * Cloud Text-to-Speech * USPS Andromeda * Vertex AI * Virtual Private Cloud (VPC) * VPC Access * VPC Service Controls Troubleshooter * VPC virtnet * Cloud Workstations * Web Risk Note: These values are supported as input for legacy purposes, but will not be returned from the API. * all * ga-only * appengine.googleapis.com * artifactregistry.googleapis.com * bigquery.googleapis.com * bigtable.googleapis.com * container.googleapis.com * cloudkms.googleapis.com * cloudresourcemanager.googleapis.com * cloudsql.googleapis.com * compute.googleapis.com * dataflow.googleapis.com * dataproc.googleapis.com * dlp.googleapis.com * iam.googleapis.com * logging.googleapis.com * orgpolicy.googleapis.com * pubsub.googleapis.com * spanner.googleapis.com * secretmanager.googleapis.com * speakerid.googleapis.com * storage.googleapis.com Calls to UpdateAccessApprovalSettings using 'all' or any of the XXX.googleapis.com will be translated to the associated product name ('all', 'App Engine', etc.). Note: 'all' will enroll the resource in all products supported at both 'GA' and 'Preview' levels. More information about levels of support is available at https://cloud.google.com/access-approval/docs/supported-services",
 "type": "string"
 },
 "enrollmentLevel": {
@@ -1243,7 +1243,7 @@
 "BLOCK_ALL"
 ],
 "enumDescriptions": [
-"Default value for proto, shouldn't be used.",
+"Default value if not set, defaults to \"BLOCK_ALL\". This value is not available to be set by the user, do not use.",
 "Service is enrolled in Access Approval for all requests"
 ],
 "type": "string"
diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json
index 4338efab776..83dee5619fd 100644
--- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json
+++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json
@@ -1659,7 +1659,7 @@
 "type": "string"
 },
 "query": {
-"description": "Query string search. Should be of the form \"\". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups",
+"description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-groups",
 "location": "query",
 "type": "string"
 },
@@ -4298,7 +4298,7 @@
 "type": "string"
 },
 "query": {
-"description": "Query string search. Should be of the form \"\". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-users",
+"description": "Query string search. Should be of the form \"\". Complete documentation is at https://developers.google.com/workspace/admin/directory/v1/guides/search-users",
 "location": "query",
 "type": "string"
 },
@@ -4671,7 +4671,7 @@
 }
 }
 },
-"revision": "20250804",
+"revision": "20250916",
 "rootUrl": "https://admin.googleapis.com/",
 "schemas": {
 "Alias": {
@@ -5841,7 +5841,7 @@ false
 "type": "string"
 },
 "osVersionCompliance": {
-"description": "Output only. Compliance status of the OS version.",
+"description": "Output only. Device policy compliance status of the OS version.",
 "enum": [
 "complianceUnspecified",
 "compliant",
diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1.json b/googleapiclient/discovery_cache/documents/apigateway.v1.json
index a0f276a8fc5..6b41dc52f1b 100644
--- a/googleapiclient/discovery_cache/documents/apigateway.v1.json
+++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json
@@ -143,7 +143,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1089,7 +1089,7 @@
 }
 }
 },
-"revision": "20250813",
+"revision": "20250910",
 "rootUrl": "https://apigateway.googleapis.com/",
 "schemas": {
 "ApigatewayApi": {
diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json
index 7468776e0b9..cfc08968248 100644
--- a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json
@@ -143,7 +143,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1089,7 +1089,7 @@
 }
 }
 },
-"revision": "20250813",
+"revision": "20250910",
 "rootUrl": "https://apigateway.googleapis.com/",
 "schemas": {
 "ApigatewayApi": {
diff --git a/googleapiclient/discovery_cache/documents/apim.v1alpha.json b/googleapiclient/discovery_cache/documents/apim.v1alpha.json
index 3520f56aacd..a3e052e5e29 100644
--- a/googleapiclient/discovery_cache/documents/apim.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/apim.v1alpha.json
@@ -169,7 +169,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -846,7 +846,7 @@
 }
 }
 },
-"revision": "20250813",
+"revision": "20250910",
 "rootUrl": "https://apim.googleapis.com/",
 "schemas": {
 "ApiObservation": {
diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json
index 1e899920d2e..3209a4a4c77 100644
--- a/googleapiclient/discovery_cache/documents/backupdr.v1.json
+++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json
@@ -169,7 +169,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -2117,7 +2117,7 @@
 }
 }
 },
-"revision": "20250902",
+"revision": "20250910",
 "rootUrl": "https://backupdr.googleapis.com/",
 "schemas": {
 "AbandonBackupRequest": {
diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json
index d93b6d33f2f..68668ed1e12 100644
--- a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json
+++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json
@@ -275,7 +275,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1899,7 +1899,7 @@
 }
 }
 },
-"revision": "20250818",
+"revision": "20250910",
 "rootUrl": "https://beyondcorp.googleapis.com/",
 "schemas": {
 "AllocatedConnection": {
diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json
index 47480eac0ea..88fb577a28a 100644
--- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json
@@ -787,7 +787,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -3432,7 +3432,7 @@
 }
 }
 },
-"revision": "20250818",
+"revision": "20250910",
 "rootUrl": "https://beyondcorp.googleapis.com/",
 "schemas": {
 "AllocatedConnection": {
diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json
index 3ceb3d3bdc0..0033c6f5840 100644
--- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1320,7 +1320,7 @@
 }
 }
 },
-"revision": "20250813",
+"revision": "20250908",
 "rootUrl": "https://certificatemanager.googleapis.com/",
 "schemas": {
 "AllowlistedCertificate": {
diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json
index b67aacb7dfb..8ae2fba7591 100644
--- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json
+++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json
@@ -169,7 +169,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -2354,7 +2354,7 @@
 }
 }
 },
-"revision": "20250813",
+"revision": "20250910",
 "rootUrl": "https://clouddeploy.googleapis.com/",
 "schemas": {
 "AbandonReleaseRequest": {
diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json
index 7669150c198..20362ebde96 100644
--- a/googleapiclient/discovery_cache/documents/config.v1.json
+++ b/googleapiclient/discovery_cache/documents/config.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1345,7 +1345,7 @@
 }
 }
 },
-"revision": "20250813",
+"revision": "20250907",
 "rootUrl": "https://config.googleapis.com/",
 "schemas": {
 "ApplyResults": {
diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json
index 71b537431cb..015687691c8 100644
--- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json
+++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json
@@ -5638,7 +5638,7 @@
 }
 }
 },
-"revision": "20250909",
+"revision": "20250915",
 "rootUrl": "https://contactcenterinsights.googleapis.com/",
 "schemas": {
 "GoogleCloudContactcenterinsightsV1Analysis": {
@@ -7829,6 +7829,7 @@ true
 "EXPORT_V8",
 "EXPORT_V9",
 "EXPORT_V10",
+"EXPORT_V11",
 "EXPORT_VERSION_LATEST_AVAILABLE"
 ],
 "enumDescriptions": [
@@ -7843,6 +7844,7 @@ true
 "Export schema version 8.",
 "Export schema version 9.",
 "Export schema version 10.",
+"Export schema version 11.",
 "Export schema version latest available."
 ],
 "type": "string"
@@ -12301,6 +12303,7 @@ true
 "EXPORT_V8",
 "EXPORT_V9",
 "EXPORT_V10",
+"EXPORT_V11",
 "EXPORT_VERSION_LATEST_AVAILABLE"
 ],
 "enumDescriptions": [
@@ -12315,6 +12318,7 @@ true
 "Export schema version 8.",
 "Export schema version 9.",
 "Export schema version 10.",
+"Export schema version 11.",
 "Export schema version latest available."
 ],
 "type": "string"
diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json
index b1e55ca76ae..87ea43f7a77 100644
--- a/googleapiclient/discovery_cache/documents/dataplex.v1.json
+++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json
@@ -809,7 +809,7 @@
 ]
 },
 "lookupEntry": {
-"description": "Looks up an entry by name using the permission on the source system.",
+"description": "Looks up an entry by name using the permission on the source system. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntry",
 "httpMethod": "GET",
 "id": "dataplex.projects.locations.lookupEntry",
@@ -2925,7 +2925,7 @@
 ]
 },
 "get": {
-"description": "Gets an Entry.",
+"description": "Gets an Entry. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}",
 "httpMethod": "GET",
 "id": "dataplex.projects.locations.entryGroups.entries.get",
@@ -2981,7 +2981,7 @@
 ]
 },
 "list": {
-"description": "Lists Entries within an EntryGroup.",
+"description": "Lists Entries within an EntryGroup. Caution: The Vertex AI, Bigtable, Spanner, Pub/Sub, Dataform, and Dataproc Metastore metadata that is stored in Dataplex Universal Catalog is changing. For more information, see Changes to metadata stored in Dataplex Universal Catalog (https://cloud.google.com/dataplex/docs/metadata-changes).",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries",
 "httpMethod": "GET",
 "id": "dataplex.projects.locations.entryGroups.entries.list",
@@ -7149,7 +7149,7 @@
 }
 }
 },
-"revision": "20250907",
+"revision": "20250915",
 "rootUrl": "https://dataplex.googleapis.com/",
 "schemas": {
 "Empty": {
@@ -9756,12 +9756,14 @@
 "enum": [
 "TRIGGER_UNSPECIFIED",
 "ON_DEMAND",
-"SCHEDULE"
+"SCHEDULE",
+"ONE_TIME"
 ],
 "enumDescriptions": [
 "An unspecified trigger type.",
 "Data scan triggers on demand.",
-"Data scan triggers as per schedule."
+"Data scan triggers as per schedule.",
+"Data scan is run one time on creation."
 ],
 "type": "string"
 },
@@ -12571,7 +12573,7 @@
 "type": "array"
 },
 "entryGroups": {
-"description": "Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.",
+"description": "Required. The entry groups that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries and aspects that belong to the specified entry groups are affected by the job.The entry groups and the job must be in the same location.",
 "items": {
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json
index 680ea7398a8..272ff6abdb8 100644
--- a/googleapiclient/discovery_cache/documents/drive.v3.json
+++ b/googleapiclient/discovery_cache/documents/drive.v3.json
@@ -158,7 +158,7 @@
 "accessproposals": {
 "methods": {
 "get": {
-"description": "Retrieves an AccessProposal by ID.",
+"description": "Retrieves an access proposal by ID. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).",
 "flatPath": "files/{fileId}/accessproposals/{proposalId}",
 "httpMethod": "GET",
 "id": "drive.accessproposals.get",
@@ -168,13 +168,13 @@
 ],
 "parameters": {
 "fileId": {
-"description": "Required. The id of the item the request is on.",
+"description": "Required. The ID of the item the request is on.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "proposalId": {
-"description": "Required. The id of the access proposal to resolve.",
+"description": "Required. The ID of the access proposal to resolve.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -193,7 +193,7 @@
 ]
 },
 "list": {
-"description": "List the AccessProposals on a file. Note: Only approvers are able to list AccessProposals on a file. If the user is not an approver, returns a 403.",
+"description": "List the access proposals on a file. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access). Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.",
 "flatPath": "files/{fileId}/accessproposals",
 "httpMethod": "GET",
 "id": "drive.accessproposals.list",
@@ -202,13 +202,13 @@
 ],
 "parameters": {
 "fileId": {
-"description": "Required. The id of the item the request is on.",
+"description": "Required. The ID of the item the request is on.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "pageSize": {
-"description": "Optional. The number of results per page",
+"description": "Optional. The number of results per page.",
 "format": "int32",
 "location": "query",
 "type": "integer"
@@ -232,7 +232,7 @@
 ]
 },
 "resolve": {
-"description": "Used to approve or deny an Access Proposal.",
+"description": "Approves or denies an access proposal. For more information, see [Manage pending access proposals](https://developers.google.com/workspace/drive/api/guides/pending-access).",
 "flatPath": "files/{fileId}/accessproposals/{proposalId}:resolve",
 "httpMethod": "POST",
 "id": "drive.accessproposals.resolve",
@@ -242,13 +242,13 @@
 ],
 "parameters": {
 "fileId": {
-"description": "Required. The id of the item the request is on.",
+"description": "Required. The ID of the item the request is on.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "proposalId": {
-"description": "Required. The id of the access proposal to resolve.",
+"description": "Required. The ID of the access proposal to resolve.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2720,7 +2720,7 @@
 }
 }
 },
-"revision": "20250829",
+"revision": "20250910",
 "rootUrl": "https://www.googleapis.com/",
 "schemas": {
 "About": {
@@ -2865,36 +2865,36 @@
 "type": "object"
 },
 "AccessProposal": {
-"description": "The Access Proposal resource for outstanding access proposals on a file",
+"description": "Manage outstanding access proposals on a file.",
 "id": "AccessProposal",
 "properties": {
 "createTime": {
-"description": "The creation time",
+"description": "The creation time.",
 "format": "google-datetime",
 "type": "string"
 },
 "fileId": {
-"description": "The file id that the proposal for access is on",
+"description": "The file ID that the proposal for access is on.",
 "type": "string"
 },
 "proposalId": {
-"description": "The id of the access proposal",
+"description": "The ID of the access proposal.",
 "type": "string"
 },
 "recipientEmailAddress": {
-"description": "The email address of the user that will receive permissions if accepted",
+"description": "The email address of the user that will receive permissions, if accepted.",
 "type": "string"
 },
 "requestMessage": {
-"description": "The message that the requester added to the proposal",
+"description": "The message that the requester added to the proposal.",
 "type": "string"
 },
 "requesterEmailAddress": {
-"description": "The email address of the requesting user",
+"description": "The email address of the requesting user.",
 "type": "string"
 },
 "rolesAndViews": {
-"description": "A wrapper for the role and view of an access proposal.",
+"description": "A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).",
 "items": {
 "$ref": "AccessProposalRoleAndView"
 },
@@ -2904,15 +2904,15 @@
 "type": "object"
 },
 "AccessProposalRoleAndView": {
-"description": "A wrapper for the role and view of an access proposal.",
+"description": "A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).",
 "id": "AccessProposalRoleAndView",
 "properties": {
 "role": {
-"description": "The role that was proposed by the requester New values may be added in the future, but the following are currently possible: * `writer` * `commenter` * `reader`",
+"description": "The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`",
 "type": "string"
 },
 "view": {
-"description": "Indicates the view for this access proposal. Only populated for proposals that belong to a view. `published` is the only supported value.",
+"description": "Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.",
 "type": "string"
 }
 },
@@ -4517,11 +4517,11 @@
 "type": "object"
 },
 "ListAccessProposalsResponse": {
-"description": "The response to an Access Proposal list request.",
+"description": "The response to an access proposal list request.",
 "id": "ListAccessProposalsResponse",
 "properties": {
 "accessProposals": {
-"description": "The list of Access Proposals. This field is only populated in v3 and v3beta.",
+"description": "The list of access proposals. This field is only populated in Drive API v3.",
 "items": {
 "$ref": "AccessProposal"
 },
@@ -4839,7 +4839,7 @@
 "id": "ResolveAccessProposalRequest",
 "properties": {
 "action": {
-"description": "Required. The action to take on the AccessProposal.",
+"description": "Required. The action to take on the access proposal.",
 "enum": [
 "ACTION_UNSPECIFIED",
 "ACCEPT",
@@ -4847,24 +4847,24 @@
 ],
 "enumDescriptions": [
 "Unspecified action",
-"The user accepts the proposal. Note: If this action is used, the `role` field must have at least one value.",
-"The user denies the proposal"
+"The user accepts the access proposal. Note: If this action is used, the `role` field must have at least one value.",
+"The user denies the access proposal."
 ],
 "type": "string"
 },
 "role": {
-"description": "Optional. The roles the approver has allowed, if any. Note: This field is required for the `ACCEPT` action.",
+"description": "Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action.",
 "items": {
 "type": "string"
 },
 "type": "array"
 },
 "sendNotification": {
-"description": "Optional. Whether to send an email to the requester when the AccessProposal is denied or accepted.",
+"description": "Optional. Whether to send an email to the requester when the access proposal is denied or accepted.",
 "type": "boolean"
 },
 "view": {
-"description": "Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. `published` is the only supported value.",
+"description": "Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported.",
 "type": "string"
 }
 },
diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json
index 2894e9db058..1c3d9ceb1ad 100644
--- a/googleapiclient/discovery_cache/documents/file.v1.json
+++ b/googleapiclient/discovery_cache/documents/file.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -908,7 +908,7 @@
 }
 }
 },
-"revision": "20250825",
+"revision": "20250910",
 "rootUrl": "https://file.googleapis.com/",
 "schemas": {
 "Backup": {
diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json
index 421adfb672b..284bda0c99b 100644
--- a/googleapiclient/discovery_cache/documents/file.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1131,7 +1131,7 @@
 }
 }
 },
-"revision": "20250819",
+"revision": "20250910",
 "rootUrl": "https://file.googleapis.com/",
 "schemas": {
 "Backup": {
diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json
index afbbad26fcc..ae7f36aca5b 100644
--- a/googleapiclient/discovery_cache/documents/firestore.v1.json
+++ b/googleapiclient/discovery_cache/documents/firestore.v1.json
@@ -1829,7 +1829,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1961,7 +1961,7 @@
 }
 }
 },
-"revision": "20250830",
+"revision": "20250908",
 "rootUrl": "https://firestore.googleapis.com/",
 "schemas": {
 "Aggregation": {
diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json
index e2f32ad6dba..8f7ed90c8ac 100644
--- a/googleapiclient/discovery_cache/documents/looker.v1.json
+++ b/googleapiclient/discovery_cache/documents/looker.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -710,7 +710,7 @@
 }
 }
 },
-"revision": "20250824",
+"revision": "20250906",
 "rootUrl": "https://looker.googleapis.com/",
 "schemas": {
 "AdminSettings": {
diff --git a/googleapiclient/discovery_cache/documents/managedkafka.v1.json b/googleapiclient/discovery_cache/documents/managedkafka.v1.json
index 7efb0d43c20..f74c0d99ca2 100644
--- a/googleapiclient/discovery_cache/documents/managedkafka.v1.json
+++ b/googleapiclient/discovery_cache/documents/managedkafka.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -2934,7 +2934,7 @@
 }
 }
 },
-"revision": "20250901",
+"revision": "20250911",
 "rootUrl": "https://managedkafka.googleapis.com/",
 "schemas": {
 "AccessConfig": {
diff --git a/googleapiclient/discovery_cache/documents/metastore.v1.json b/googleapiclient/discovery_cache/documents/metastore.v1.json
index 86dcee5f6b8..9bc91bfb3a4 100644
--- a/googleapiclient/discovery_cache/documents/metastore.v1.json
+++ b/googleapiclient/discovery_cache/documents/metastore.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1690,7 +1690,7 @@
 }
 }
 },
-"revision": "20250814",
+"revision": "20250911",
 "rootUrl": "https://metastore.googleapis.com/",
 "schemas": {
 "AlterMetadataResourceLocationRequest": {
diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json
index 371f88bb563..c543cdac316 100644
--- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1802,7 +1802,7 @@
 }
 }
 },
-"revision": "20250814",
+"revision": "20250911",
 "rootUrl": "https://metastore.googleapis.com/",
 "schemas": {
 "AlterMetadataResourceLocationRequest": {
diff --git a/googleapiclient/discovery_cache/documents/metastore.v1beta.json b/googleapiclient/discovery_cache/documents/metastore.v1beta.json
index aa2c9b7469f..fb237b0329b 100644
--- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1802,7 +1802,7 @@
 }
 }
 },
-"revision": "20250814",
+"revision": "20250911",
 "rootUrl": "https://metastore.googleapis.com/",
 "schemas": {
 "AlterMetadataResourceLocationRequest": {
diff --git a/googleapiclient/discovery_cache/documents/parallelstore.v1.json b/googleapiclient/discovery_cache/documents/parallelstore.v1.json
index 1bb3c35058a..2d1ed7a31f3 100644
--- a/googleapiclient/discovery_cache/documents/parallelstore.v1.json
+++ b/googleapiclient/discovery_cache/documents/parallelstore.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -549,7 +549,7 @@
 }
 }
 },
-"revision": "20250820",
+"revision": "20250908",
 "rootUrl": "https://parallelstore.googleapis.com/",
 "schemas": {
 "CancelOperationRequest": {
diff --git a/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json b/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json
index c20be3c370a..e5c782075b9 100644
--- a/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/parallelstore.v1beta.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -546,7 +546,7 @@
 }
 }
 },
-"revision": "20250820",
+"revision": "20250908",
 "rootUrl": "https://parallelstore.googleapis.com/",
 "schemas": {
 "DestinationGcsBucket": {
diff --git a/googleapiclient/discovery_cache/documents/parametermanager.v1.json b/googleapiclient/discovery_cache/documents/parametermanager.v1.json
index fc51b089aad..5617d8ce0d5 100644
--- a/googleapiclient/discovery_cache/documents/parametermanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/parametermanager.v1.json
@@ -271,7 +271,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -721,7 +721,7 @@
 }
 }
 },
-"revision": "20250813",
+"revision": "20250910",
 "rootUrl": "https://parametermanager.googleapis.com/",
 "schemas": {
 "Empty": {
diff --git a/googleapiclient/discovery_cache/documents/privateca.v1.json b/googleapiclient/discovery_cache/documents/privateca.v1.json
index b837643e7c5..7adc26b2947 100644
--- a/googleapiclient/discovery_cache/documents/privateca.v1.json
+++ b/googleapiclient/discovery_cache/documents/privateca.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1611,7 +1611,7 @@
 }
 }
 },
-"revision": "20250901",
+"revision": "20250910",
 "rootUrl": "https://privateca.googleapis.com/",
 "schemas": {
 "AccessUrls": {
diff --git a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json
index 1a6a7cb7441..9340fbb37e7 100644
--- a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -586,7 +586,7 @@
 }
 }
 },
-"revision": "20250901",
+"revision": "20250910",
 "rootUrl": "https://privateca.googleapis.com/",
 "schemas": {
 "AuditConfig": {
diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json
index efa5c2dd2c0..7928c9cbb45 100644
--- a/googleapiclient/discovery_cache/documents/run.v1.json
+++ b/googleapiclient/discovery_cache/documents/run.v1.json
@@ -870,7 +870,7 @@
 ],
 "parameters": {
 "name": {
-"description": "Required. The name of the job to retrieve. Replace {namespace} with the project ID or number. It takes the form namespaces/{namespace}. For example: namespaces/PROJECT_ID",
+"description": "Required. The name of the job to retrieve. It takes the form namespaces/{namespace}/jobs/{job_name} and the `endpoint` must be regional. Replace {namespace} with the project ID or number.",
 "location": "path",
 "pattern": "^namespaces/[^/]+/jobs/[^/]+$",
 "required": true,
@@ -2902,7 +2902,7 @@
 }
 }
 },
-"revision": "20250905",
+"revision": "20250912",
 "rootUrl": "https://run.googleapis.com/",
 "schemas": {
 "Addressable": {
diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json
index 1cc4f01b9ab..72b1965a206 100644
--- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1804,7 +1804,7 @@
 }
 }
 },
-"revision": "20250903",
+"revision": "20250910",
 "rootUrl": "https://saasservicemgmt.googleapis.com/",
 "schemas": {
 "Aggregate": {
diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json
index f68cb902e33..3ac4fbd60a7 100644
--- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json
@@ -326,7 +326,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1296,7 +1296,7 @@
 }
 }
 },
-"revision": "20250902",
+"revision": "20250910",
 "rootUrl": "https://secretmanager.googleapis.com/",
 "schemas": {
 "AccessSecretVersionResponse": {
diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json
index abb3674d993..b2ced87ea3f 100644
--- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json
@@ -326,7 +326,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -816,7 +816,7 @@
 }
 }
 },
-"revision": "20250902",
+"revision": "20250910",
 "rootUrl": "https://secretmanager.googleapis.com/",
 "schemas": {
 "AccessSecretVersionResponse": {
diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json
index 3c9acc51883..d840f338b3e 100644
--- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json
@@ -326,7 +326,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1296,7 +1296,7 @@
 }
 }
 },
-"revision": "20250902",
+"revision": "20250910",
 "rootUrl": "https://secretmanager.googleapis.com/",
 "schemas": {
 "AccessSecretVersionResponse": {
diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json
index 5de0bd1da46..f2a2465d5d0 100644
--- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json
+++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json
@@ -5938,7 +5938,7 @@
 }
 }
 },
-"revision": "20250905",
+"revision": "20250915",
 "rootUrl": "https://securitycenter.googleapis.com/",
 "schemas": {
 "Access": {
@@ -6063,12 +6063,16 @@
 "enum": [
 "DEPLOYMENT_PLATFORM_UNSPECIFIED",
 "VERTEX_AI",
-"GKE"
+"GKE",
+"GCE",
+"FINE_TUNED_MODEL"
 ],
 "enumDescriptions": [
 "Unspecified deployment platform.",
 "Vertex AI.",
-"Google Kubernetes Engine."
+"Google Kubernetes Engine.",
+"Google Compute Engine.",
+"Fine tuned model."
 ],
 "type": "string"
 },
@@ -7454,11 +7458,15 @@
 "description": "Type of the DRD event.",
 "enum": [
 "EVENT_TYPE_UNSPECIFIED",
-"EVENT_TYPE_MAX_TTL_EXCEEDED"
+"EVENT_TYPE_MAX_TTL_EXCEEDED",
+"EVENT_TYPE_MAX_TTL_FROM_CREATION",
+"EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION"
 ],
 "enumDescriptions": [
 "Unspecified event type.",
-"The maximum retention time has been exceeded."
+"The maximum retention time has been exceeded.",
+"Max TTL from the asset's creation time.",
+"Max TTL from the asset's last modification time."
 ],
 "type": "string"
 },
@@ -9459,12 +9467,16 @@
 "enum": [
 "DEPLOYMENT_PLATFORM_UNSPECIFIED",
 "VERTEX_AI",
-"GKE"
+"GKE",
+"GCE",
+"FINE_TUNED_MODEL"
 ],
 "enumDescriptions": [
 "Unspecified deployment platform.",
 "Vertex AI.",
-"Google Kubernetes Engine."
+"Google Kubernetes Engine.",
+"Google Compute Engine.",
+"Fine tuned model."
 ],
 "type": "string"
 },
@@ -10542,11 +10554,15 @@
 "description": "Type of the DRD event.",
 "enum": [
 "EVENT_TYPE_UNSPECIFIED",
-"EVENT_TYPE_MAX_TTL_EXCEEDED"
+"EVENT_TYPE_MAX_TTL_EXCEEDED",
+"EVENT_TYPE_MAX_TTL_FROM_CREATION",
+"EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION"
 ],
 "enumDescriptions": [
 "Unspecified event type.",
-"The maximum retention time has been exceeded."
+"The maximum retention time has been exceeded.",
+"Max TTL from the asset's creation time.",
+"Max TTL from the asset's last modification time."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json
index 950afda1f7c..476970df16a 100644
--- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json
@@ -913,7 +913,7 @@
 }
 }
 },
-"revision": "20250905",
+"revision": "20250915",
 "rootUrl": "https://securitycenter.googleapis.com/",
 "schemas": {
 "Access": {
@@ -1038,12 +1038,16 @@
 "enum": [
 "DEPLOYMENT_PLATFORM_UNSPECIFIED",
 "VERTEX_AI",
-"GKE"
+"GKE",
+"GCE",
+"FINE_TUNED_MODEL"
 ],
 "enumDescriptions": [
 "Unspecified deployment platform.",
 "Vertex AI.",
-"Google Kubernetes Engine."
+"Google Kubernetes Engine.",
+"Google Compute Engine.",
+"Fine tuned model."
 ],
 "type": "string"
 },
@@ -2189,11 +2193,15 @@
 "description": "Type of the DRD event.",
 "enum": [
 "EVENT_TYPE_UNSPECIFIED",
-"EVENT_TYPE_MAX_TTL_EXCEEDED"
+"EVENT_TYPE_MAX_TTL_EXCEEDED",
+"EVENT_TYPE_MAX_TTL_FROM_CREATION",
+"EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION"
 ],
 "enumDescriptions": [
 "Unspecified event type.",
-"The maximum retention time has been exceeded."
+"The maximum retention time has been exceeded.",
+"Max TTL from the asset's creation time.",
+"Max TTL from the asset's last modification time."
 ],
 "type": "string"
 },
@@ -4129,12 +4137,16 @@
 "enum": [
 "DEPLOYMENT_PLATFORM_UNSPECIFIED",
 "VERTEX_AI",
-"GKE"
+"GKE",
+"GCE",
+"FINE_TUNED_MODEL"
 ],
 "enumDescriptions": [
 "Unspecified deployment platform.",
 "Vertex AI.",
-"Google Kubernetes Engine."
+"Google Kubernetes Engine.",
+"Google Compute Engine.",
+"Fine tuned model."
 ],
 "type": "string"
 },
@@ -5212,11 +5224,15 @@
 "description": "Type of the DRD event.",
 "enum": [
 "EVENT_TYPE_UNSPECIFIED",
-"EVENT_TYPE_MAX_TTL_EXCEEDED"
+"EVENT_TYPE_MAX_TTL_EXCEEDED",
+"EVENT_TYPE_MAX_TTL_FROM_CREATION",
+"EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION"
 ],
 "enumDescriptions": [
 "Unspecified event type.",
-"The maximum retention time has been exceeded."
+"The maximum retention time has been exceeded.",
+"Max TTL from the asset's creation time.",
+"Max TTL from the asset's last modification time."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json
index 28c7341acba..95099abe543 100644
--- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json
+++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json
@@ -2003,7 +2003,7 @@
 }
 }
 },
-"revision": "20250905",
+"revision": "20250915",
 "rootUrl": "https://securitycenter.googleapis.com/",
 "schemas": {
 "Access": {
@@ -2128,12 +2128,16 @@
 "enum": [
 "DEPLOYMENT_PLATFORM_UNSPECIFIED",
 "VERTEX_AI",
-"GKE"
+"GKE",
+"GCE",
+"FINE_TUNED_MODEL"
 ],
 "enumDescriptions": [
 "Unspecified deployment platform.",
 "Vertex AI.",
-"Google Kubernetes Engine."
+"Google Kubernetes Engine.",
+"Google Compute Engine.",
+"Fine tuned model."
 ],
 "type": "string"
 },
@@ -3215,11 +3219,15 @@
 "description": "Type of the DRD event.",
 "enum": [
 "EVENT_TYPE_UNSPECIFIED",
-"EVENT_TYPE_MAX_TTL_EXCEEDED"
+"EVENT_TYPE_MAX_TTL_EXCEEDED",
+"EVENT_TYPE_MAX_TTL_FROM_CREATION",
+"EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION"
 ],
 "enumDescriptions": [
 "Unspecified event type.",
-"The maximum retention time has been exceeded."
+"The maximum retention time has been exceeded.",
+"Max TTL from the asset's creation time.",
+"Max TTL from the asset's last modification time."
 ],
 "type": "string"
 },
@@ -5122,12 +5130,16 @@
 "enum": [
 "DEPLOYMENT_PLATFORM_UNSPECIFIED",
 "VERTEX_AI",
-"GKE"
+"GKE",
+"GCE",
+"FINE_TUNED_MODEL"
 ],
 "enumDescriptions": [
 "Unspecified deployment platform.",
 "Vertex AI.",
-"Google Kubernetes Engine."
+"Google Kubernetes Engine.",
+"Google Compute Engine.",
+"Fine tuned model."
 ],
 "type": "string"
 },
@@ -6205,11 +6217,15 @@
 "description": "Type of the DRD event.",
 "enum": [
 "EVENT_TYPE_UNSPECIFIED",
-"EVENT_TYPE_MAX_TTL_EXCEEDED"
+"EVENT_TYPE_MAX_TTL_EXCEEDED",
+"EVENT_TYPE_MAX_TTL_FROM_CREATION",
+"EVENT_TYPE_MAX_TTL_FROM_LAST_MODIFICATION"
 ],
 "enumDescriptions": [
 "Unspecified event type.",
-"The maximum retention time has been exceeded."
+"The maximum retention time has been exceeded.",
+"Max TTL from the asset's creation time.",
+"Max TTL from the asset's last modification time."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json
index a76917919d2..aec0adc59d6 100644
--- a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json
+++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -889,7 +889,7 @@
 }
 }
 },
-"revision": "20250822",
+"revision": "20250906",
 "rootUrl": "https://servicedirectory.googleapis.com/",
 "schemas": {
 "Binding": {
diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json
index bdc2084c3b8..8fd9038f236 100644
--- a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -977,7 +977,7 @@
 }
 }
 },
-"revision": "20250822",
+"revision": "20250906",
 "rootUrl": "https://servicedirectory.googleapis.com/",
 "schemas": {
 "Binding": {
diff --git a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json
index 51447034a47..311a7ae2bdd 100644
--- a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json
+++ b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -482,7 +482,7 @@
 }
 }
 },
-"revision": "20250813",
+"revision": "20250910",
 "rootUrl": "https://storagebatchoperations.googleapis.com/",
 "schemas": {
 "Bucket": {
diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json
index 0ab86b7467b..986c9db9129 100644
--- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json
+++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json
@@ -318,7 +318,7 @@
 }
 }
 },
-"revision": "20250903",
+"revision": "20250912",
 "rootUrl": "https://texttospeech.googleapis.com/",
 "schemas": {
 "AdvancedVoiceOptions": {
@@ -623,7 +623,7 @@
 "description": "The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis."
 },
 "prompt": {
-"description": "This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions.",
+"description": "This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions.",
 "type": "string"
 },
 "ssml": {
diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json
index ff524f4c246..72c40a2601e 100644
--- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json
@@ -261,7 +261,7 @@
 }
 }
 },
-"revision": "20250903",
+"revision": "20250912",
 "rootUrl": "https://texttospeech.googleapis.com/",
 "schemas": {
 "AdvancedVoiceOptions": {
@@ -556,7 +556,7 @@
 "description": "The multi-speaker input to be synthesized. Only applicable for multi-speaker synthesis."
 },
 "prompt": {
-"description": "This is system instruction supported only for controllable voice models. If used, we will pass text to Flash TTS as is. Can only used with Flash TTS. What AI Studio calls Style Instructions.",
+"description": "This system instruction is supported only for controllable/promptable voice models. If this system instruction is used, we pass the unedited text to Gemini-TTS. Otherwise, a default system instruction is used. AI Studio calls this system instruction, Style Instructions.",
 "type": "string"
 },
 "ssml": {
diff --git a/googleapiclient/discovery_cache/documents/vpcaccess.v1.json b/googleapiclient/discovery_cache/documents/vpcaccess.v1.json
index 4b27f831c37..f3cafb208c9 100644
--- a/googleapiclient/discovery_cache/documents/vpcaccess.v1.json
+++ b/googleapiclient/discovery_cache/documents/vpcaccess.v1.json
@@ -119,7 +119,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -390,7 +390,7 @@
 }
 }
 },
-"revision": "20250817",
+"revision": "20250916",
 "rootUrl": "https://vpcaccess.googleapis.com/",
 "schemas": {
 "Connector": {
diff --git a/googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json b/googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json
index cd6e3630bdb..e375ef49f15 100644
--- a/googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/vpcaccess.v1beta1.json
@@ -119,7 +119,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -390,7 +390,7 @@
 }
 }
 },
-"revision": "20250817",
+"revision": "20250916",
 "rootUrl": "https://vpcaccess.googleapis.com/",
 "schemas": {
 "Connector": {
diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json
index 42db0aa3e67..b63d6cfb572 100644
--- a/googleapiclient/discovery_cache/documents/workstations.v1.json
+++ b/googleapiclient/discovery_cache/documents/workstations.v1.json
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1216,7 +1216,7 @@
 }
 }
 },
-"revision": "20250814",
+"revision": "20250915",
 "rootUrl": "https://workstations.googleapis.com/",
 "schemas": {
 "Accelerator": {