- [Resource: WidgetConfig](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig)
  - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.SCHEMA_REPRESENTATION)
  - [UIComponentField](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UIComponentField)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UIComponentField.SCHEMA_REPRESENTATION)
  - [DeviceVisibility](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DeviceVisibility)
  - [FacetField](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.FacetField)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.FacetField.SCHEMA_REPRESENTATION)
  - [DataStoreType](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreType)
  - [ResultDisplayType](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ResultDisplayType)
  - [DataStoreUiConfig](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreUiConfig)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreUiConfig.SCHEMA_REPRESENTATION)
  - [CollectionComponent](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CollectionComponent)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CollectionComponent.SCHEMA_REPRESENTATION)
  - [DataStoreComponent](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreComponent)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreComponent.SCHEMA_REPRESENTATION)
  - [DataStoreConfigType](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreConfigType)
  - [ConnectorAuthState](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ConnectorAuthState)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ConnectorAuthState.SCHEMA_REPRESENTATION)
  - [AuthState](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AuthState)
  - [UiSettings](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UiSettings)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UiSettings.SCHEMA_REPRESENTATION)
  - [InteractionType](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.InteractionType)
  - [GenerativeAnswerConfig](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.GenerativeAnswerConfig)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.GenerativeAnswerConfig.SCHEMA_REPRESENTATION)
  - [ImageSource](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ImageSource)
  - [FeatureState](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.FeatureState)
  - [ModelState](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ModelState)
  - [SearchAddonSpec](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.SearchAddonSpec)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.SearchAddonSpec.SCHEMA_REPRESENTATION)
  - [ModelConfigInfo](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ModelConfigInfo)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ModelConfigInfo.SCHEMA_REPRESENTATION)
  - [ResolvedModel](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ResolvedModel)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ResolvedModel.SCHEMA_REPRESENTATION)
  - [AdminView](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AdminView)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AdminView.SCHEMA_REPRESENTATION)
  - [AccessSettings](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AccessSettings)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AccessSettings.SCHEMA_REPRESENTATION)
  - [UiBrandingSettings](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UiBrandingSettings)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UiBrandingSettings.SCHEMA_REPRESENTATION)
  - [Image](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Image)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Image.SCHEMA_REPRESENTATION)
  - [HomepageSetting](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.HomepageSetting)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.HomepageSetting.SCHEMA_REPRESENTATION)
  - [Shortcut](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Shortcut)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Shortcut.SCHEMA_REPRESENTATION)
  - [AssistantSettings](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AssistantSettings)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AssistantSettings.SCHEMA_REPRESENTATION)
  - [WebGroundingType](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.WebGroundingType)
  - [MapsGroundingType](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.MapsGroundingType)
  - [CustomerProvidedConfig](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CustomerProvidedConfig)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CustomerProvidedConfig.SCHEMA_REPRESENTATION)
  - [CustomerType](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CustomerType)
  - [ComplianceLevel](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ComplianceLevel)
  - [BatchAuthStatus](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.BatchAuthStatus)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.BatchAuthStatus.SCHEMA_REPRESENTATION)
  - [Node](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Node)
    - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Node.SCHEMA_REPRESENTATION)
  - [Type](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Type)
- [Methods](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#METHODS_SUMMARY)

## Resource: WidgetConfig

WidgetConfig captures configs at the Widget level.

| JSON representation |
|---|
| ``` { "name": string, "displayName": string, "createTime": string, "updateTime": string, "enableAutocomplete": boolean, "fieldsUiComponentsMap": { string: { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UIComponentField`) }, ... }, "facetField": [ { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.FacetField`) } ], "dataStoreType": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreType`), "contentSearchSpec": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/ContentSearchSpec`) }, "enableSummarization": boolean, "enableSnippetResultSummary": boolean, "configId": string, "enableQualityFeedback": boolean, "solutionType": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/SolutionType`), "industryVertical": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/IndustryVertical`), "allowPublicAccess": boolean, "allowlistedDomains": [ string ], "enableSafeSearch": boolean, "enableConversationalSearch": boolean, "llmEnabled": boolean, "enableResultScore": boolean, "resultDisplayType": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ResultDisplayType`), "minimumDataTermAccepted": boolean, "enableWebApp": boolean, "dataStoreUiConfigs": [ { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreUiConfig`) } ], "collectionComponents": [ { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CollectionComponent`) } ], "enableSearchAsYouType": boolean, "defaultSearchRequestOrderBy": string, "uiSettings": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UiSettings`) }, "accessSettings": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AccessSettings`) }, "uiBranding": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UiBrandingSettings`) }, "homepageSetting": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.HomepageSetting`) }, "assistantSettings": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AssistantSettings`) }, "customerProvidedConfig": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CustomerProvidedConfig`) }, "enablePrivateKnowledgeGraph": boolean, "geminiBundle": boolean, "batchAuthStatuses": [ { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.BatchAuthStatus`) } ], "nodes": [ { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Node`) } ] } ``` |

| Fields ||
|---|---|
| `name` | `string` Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| `displayName` | `string` Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig` was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. Timestamp the `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig` was updated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `enableAutocomplete (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Whether or not to enable autocomplete. |
| `fieldsUiComponentsMap (deprecated)` | ``map (key: string, value: object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UIComponentField`))`` > [!WARNING] > This item is deprecated! The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. |
| `facetField[] (deprecated)` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.FacetField`)`` > [!WARNING] > This item is deprecated! The configuration and appearance of facets in the end user view. |
| `dataStoreType` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreType`)`` Output only. The type of the parent data store. |
| `contentSearchSpec (deprecated)` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/ContentSearchSpec`)`` > [!WARNING] > This item is deprecated! The content search spec that configs the desired behavior of content search. |
| `enableSummarization (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Turn on or off summarization for the search response. |
| `enableSnippetResultSummary (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Turn on or off summary for each snippets result. |
| `configId` | `string` Output only. Unique obfuscated identifier of a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig`. |
| `enableQualityFeedback (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Turn on or off collecting the search result quality feedback from end users. |
| `solutionType` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/SolutionType`)`` Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. |
| `industryVertical` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/IndustryVertical`)`` Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.engines#Engine`. |
| `allowPublicAccess (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server. |
| `allowlistedDomains[] (deprecated)` | `string` > [!WARNING] > This item is deprecated! Allowlisted domains that can load this widget. |
| `enableSafeSearch (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Whether to enable safe search. |
| `enableConversationalSearch (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). |
| `llmEnabled` | `boolean` Output only. Whether LLM is enabled in the corresponding data store. |
| `enableResultScore` | `boolean` Whether to show the result score. |
| `resultDisplayType (deprecated)` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ResultDisplayType`)`` > [!WARNING] > This item is deprecated! The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users. |
| `minimumDataTermAccepted` | `boolean` Output only. Whether the customer accepted data use terms. |
| `enableWebApp (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Whether to enable standalone web app. |
| `dataStoreUiConfigs[] (deprecated)` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreUiConfig`)`` > [!WARNING] > This item is deprecated! Configurable UI configurations per data store. |
| `collectionComponents[]` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CollectionComponent`)`` Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, this list is additionally augmented with synthetic placeholder entries for connectors the caller may attach but has not yet attached (see `CollectionComponent` for the placeholder contract). The frontend can therefore render a unified list of already-attached and available-to-attach sources by iterating this single field. For Enterprise engines and for the default `view`, only already-attached connectors are returned (today's behavior). |
| `enableSearchAsYouType (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Whether to enable search-as-you-type behavior for the search widget |
| `defaultSearchRequestOrderBy (deprecated)` | `string` > [!WARNING] > This item is deprecated! The default ordering for search results if specified. Used to set SearchRequest#orderBy on applicable requests. <https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body> |
| `uiSettings` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UiSettings`)`` Describes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties. |
| `accessSettings` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AccessSettings`)`` Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties. |
| `uiBranding` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UiBrandingSettings`)`` Describes search widget UI branding settings, such as the widget title, logo, favicons, and colors. |
| `homepageSetting` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.HomepageSetting`)`` Optional. Describes the homepage settings of the widget. |
| `assistantSettings` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AssistantSettings`)`` Optional. Output only. Describes the assistant settings of the widget. |
| `customerProvidedConfig` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CustomerProvidedConfig`)`` Optional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. |
| `enablePrivateKnowledgeGraph` | `boolean` Optional. Output only. Whether to enable private knowledge graph. |
| `geminiBundle` | `boolean` Output only. Whether the subscription is gemini bundle or not. |
| `batchAuthStatuses[]` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.BatchAuthStatus`)`` Output only. The batch authorization statuses for the widget's connectors. |
| `nodes[]` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Node`)`` Output only. The nodes associated with the Widget Config. |

### UIComponentField

Facet field that maps to a UI Component.

| JSON representation |
|---|
| ``` { "field": string, "deviceVisibility": [ enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DeviceVisibility`) ], "displayTemplate": string } ``` |

| Fields ||
|---|---|
| `field` | `string` Required. Registered field name. The format is `field.abc`. |
| `deviceVisibility[]` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DeviceVisibility`)`` The field visibility on different types of devices. |
| `displayTemplate` | `string` The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". |

### DeviceVisibility

The visibility of the field on different type of devices.

| Enums ||
|---|---|
| `DEVICE_VISIBILITY_UNSPECIFIED` | Default value when not specified. Server returns INVALID_ARGUMENT if used in requests. |
| `MOBILE` | The UI component is visible on Mobile devices. |
| `DESKTOP` | The UI component is visible on Browser-based client. |

### FacetField

Facet fields that store the mapping of fields to end user widget appearance.

| JSON representation |
|---|
| ``` { "field": string, "displayName": string } ``` |

| Fields ||
|---|---|
| `field` | `string` Required. Registered field name. The format is `field.abc`. |
| `displayName` | `string` Optional. The field name that end users will see. |

### DataStoreType

The type of the widget's parent data store.

| Enums ||
|---|---|
| `DATA_STORE_TYPE_UNSPECIFIED` | Unspecified data store type. |
| `SITE_SEARCH` | The parent data store contains a site search engine. |
| `STRUCTURED` | The parent data store contains a search engine for structured data. |
| `UNSTRUCTURED` | The parent data store contains a search engine for unstructured data. |
| `BLENDED` | The parent data store is served for blended search with multiple data stores. |

### ResultDisplayType

The type of result to display in the ucs widget.

| Enums ||
|---|---|
| `RESULT_DISPLAY_TYPE_UNSPECIFIED` | Unspecified display type (default to showing snippet). |
| `SNIPPET` | Display results from the snippet field. |
| `EXTRACTIVE_ANSWER` | Display results from extractive answers field. |

### DataStoreUiConfig

UI component configuration for data store.

| JSON representation |
|---|
| ``` { "name": string, "id": string, "facetField": [ { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.FacetField`) } ], "fieldsUiComponentsMap": { string: { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UIComponentField`) }, ... } } ``` |

| Fields ||
|---|---|
| `name` | `string` The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}`. For APIs under `WidgetService`, such as `WidgetService.LookupWidgetConfig`, the project number and location part is erased in this field. |
| `id` | `string` Output only. the identifier of the data store, used for widget service. For now it refers to dataStoreId, in the future we will migrate the field to encrypted data store name UUID. |
| `facetField[]` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.FacetField`)`` Facet fields that store the mapping of fields to end user widget appearance. |
| `fieldsUiComponentsMap` | ``map (key: string, value: object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.UIComponentField`))`` The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. |

### CollectionComponent

Read-only collection component that contains data store collections fields that may be used for filtering.

For SaaS / Business engines, when `LookupWidgetConfig` is called with `view = WITH_AVAILABLE_CONNECTORS`, instances of this message are also used to represent synthetic placeholder entries for connectors the caller may attach but has not yet attached. Placeholder entries have `connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED` (or `NO_AUTH`), an empty `connectorAuthState.authorization_uri` (the widget calls `WidgetBuildAuthorizationUrl` on the user's "Connect" click), and synthetic placeholder values in `name` / `id` (see field comments). Fields that only make sense for materialized connectors (`dataStoreComponents`, `tenant`, `actionConnector`) are left unset for placeholder entries.

| JSON representation |
|---|
| ``` { "name": string, "id": string, "displayName": string, "dataStoreComponents": [ { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreComponent`) } ], "dataSource": string, "dataSourceVersion": number, "dataSourceDisplayName": string, "dataSourceEndUserDisplayName": string, "connectorIconLink": string, "connectorAuthState": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ConnectorAuthState`) }, "metadata": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/ConnectorMetadata`) }, "isFirstParty": boolean, "tag": string } ``` |

| Fields ||
|---|---|
| `name` | `string` The name of the collection. It should be collection resource name. Format: `projects/{project}/locations/{location}/collections/{collectionId}`. For APIs under `WidgetService`, such as `WidgetService.LookupWidgetConfig`, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection ID that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector. |
| `id` | `string` Output only. the identifier of the collection, used for widget service. For now it refers to collectionId, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collectionId. |
| `displayName` | `string` The display name of the collection. |
| `dataStoreComponents[]` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreComponent`)`` For the data store collection, list of the children data stores. |
| `dataSource` | `string` The name of the data source, retrieved from `Collection.data_connector.data_source`. |
| `dataSourceVersion` | `number` Output only. The version of the connector definition backing this collection, mirroring `DataConnector.data_source_version`. |
| `dataSourceDisplayName` | `string` Output only. The display name of the data source. |
| `dataSourceEndUserDisplayName` | `string` Output only. The end-user-facing display name of the data source, sourced from `ConnectorSource.end_user_display_name`. When unset, clients fall back to `dataSourceDisplayName`. |
| `connectorIconLink` | `string` Output only. The icon link of the connector source. |
| `connectorAuthState` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ConnectorAuthState`)`` Output only. The auth uri of the connector source. |
| `metadata` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/ConnectorMetadata`)`` Output only. User-facing connector metadata (`title`, `description`, `shortDescription`, `author`, `note`), retrieved from the registry `ConnectorSource.metadata` (joined by data source). Shown on the connector detail page. |
| `isFirstParty` | `boolean` Output only. Whether this is a first-party (Google-owned) connector, as opposed to a third-party connector. Used by the frontend to group 1P vs 3P connectors. |
| `tag` | `string` Output only. The version-independent label of the connector backing this collection, mirroring `DataConnector.tag`. Unlike the version-pinned data store ID it survives a connector version upgrade, so an upgraded connector keeps the same tag. Not a unique key. As `DataConnector.tag` documents, several connectors may share a tag under the same (project, location, collection, dataSource), and tag-based lookup resolves to the one with the greatest createTime. Clients must not treat this as a connector identifier. Empty when the connector was created before the tag-write launch, and for synthetic placeholder entries, which have no underlying `DataConnector`. Populated only when `ConnectorsFeature.enable_connector_tag` is on. |

### DataStoreComponent

Read-only data store component that contains data stores fields that may be used for filtering, it's the child of `CollectionComponent`.

| JSON representation |
|---|
| ``` { "name": string, "id": string, "displayName": string, "entityName": string, "workspaceType": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/Type`), "contentConfig": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/ContentConfig`), "dataStoreConfigType": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreConfigType`) } ``` |

| Fields ||
|---|---|
| `name` | `string` The name of the data store. It should be data store resource name Format: `projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}`. For APIs under `WidgetService`, such as `WidgetService.LookupWidgetConfig`, the project number and location part is erased in this field. |
| `id` | `string` Output only. the identifier of the data store, used for widget service. For now it refers to dataStoreId, in the future we will migrate the field to encrypted data store name UUID. |
| `displayName` | `string` The display name of the data store. |
| `entityName` | `string` The name of the entity, retrieved from `Collection.data_connector.entities.entityName`. |
| `workspaceType` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/Type`)`` Output only. Workspace Source Types for workspace data, retrieved from `DataStore.workspace_config.type`. |
| `contentConfig` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/ContentConfig`)`` Output only. The content config of the data store. |
| `dataStoreConfigType` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreConfigType`)`` Output only. The type of the data store config. |

### DataStoreConfigType

The type of the data store config.

| Enums ||
|---|---|
| `DATA_STORE_CONFIG_TYPE_UNSPECIFIED` | Default value. This value is unused. |
| `ALLOW_DB_CONFIG` | The data store is connected to AlloyDB |
| `THIRD_PARTY_OAUTH_CONFIG` | The data store is a connected to a third party data source. |
| `NOTEBOOKLM_CONFIG` | The data store is a connected to NotebookLM Enterprise. |

### ConnectorAuthState

Read-only connector in CollectionComponent auth state.

| JSON representation |
|---|
| ``` { "authState": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AuthState`), "authorizationUri": string, "updateTime": string } ``` |

| Fields ||
|---|---|
| `authState` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AuthState`)`` Output only. The authorization state of the data connector. |
| `authorizationUri` | `string` Output only. The authorization uri for the data connector. For synthetic placeholder `CollectionComponent` entries (returned by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` on SaaS / Business engines), this field is left empty. The widget should call `WidgetService.WidgetBuildAuthorizationUrl` on the user's "Connect" click to obtain a freshly-built authorization URL. |
| `updateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The authorization state update timestamp. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |

### AuthState

The authorization state of the data connector.

| Enums ||
|---|---|
| `AUTH_STATE_UNSPECIFIED` | Default value. Also returned for synthetic placeholder `CollectionComponent` entries surfaced by `LookupWidgetConfig` with `view = WITH_AVAILABLE_CONNECTORS` (SaaS / Business only) --- those entries represent connectors the caller may attach but has not yet attached. |
| `AUTHORIZED` | The user has authorized the data connector. |
| `EXPIRED` | The user authorization for the data connector has expired. |
| `ACTIONS_DISABLED` | The user can still make search requests but actions need to be enabled. |
| `NO_AUTH` | The data connector does not require any authorization. Also used for placeholder entries whose underlying connector does not require user OAuth. |

### UiSettings

Describes general widget (or web app) UI settings as seen in the cloud console UI configuration page.

| JSON representation |
|---|
| ``` { "interactionType": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.InteractionType`), "generativeAnswerConfig": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.GenerativeAnswerConfig`) }, "resultDescriptionType": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ResultDisplayType`), "enableAutocomplete": boolean, "enableSafeSearch": boolean, "enableQualityFeedback": boolean, "enableSearchAsYouType": boolean, "defaultSearchRequestOrderBy": string, "dataStoreUiConfigs": [ { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreUiConfig`) } ], "disableUserEventsCollection": boolean, "enableVisualContentSummary": boolean, "enablePeopleSearch": boolean, "enableCreateAgentButton": boolean, "features": { string: enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.FeatureState`), ... }, "modelConfigs": { string: enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ModelState`), ... }, "searchAddonSpec": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.SearchAddonSpec`) }, "modelConfigInfo": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ModelConfigInfo`) }, "sourceAdminDisplayNameEnabled": boolean, "onedrivePickerEnabled": boolean, "googleDrivePickerEnabled": boolean } ``` |

| Fields ||
|---|---|
| `interactionType` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.InteractionType`)`` Describes widget (or web app) interaction type |
| `generativeAnswerConfig` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.GenerativeAnswerConfig`)`` Describes generative answer configuration. |
| `resultDescriptionType` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ResultDisplayType`)`` Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. |
| `enableAutocomplete` | `boolean` Whether or not to enable autocomplete. |
| `enableSafeSearch` | `boolean` Whether to enable safe search. |
| `enableQualityFeedback` | `boolean` Turn on or off collecting the search result quality feedback from end users. |
| `enableSearchAsYouType` | `boolean` Whether to enable search-as-you-type behavior for the search widget. |
| `defaultSearchRequestOrderBy` | `string` The default ordering for search results if specified. Used to set SearchRequest#orderBy on applicable requests. <https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body> |
| `dataStoreUiConfigs[]` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.DataStoreUiConfig`)`` Per data store configuration. |
| `disableUserEventsCollection` | `boolean` If set to true, the widget will not collect user events. |
| `enableVisualContentSummary` | `boolean` If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. |
| `enablePeopleSearch` | `boolean` Optional. If set to true, the widget will enable people search. |
| `enableCreateAgentButton` | `boolean` Optional. If set to true, the widget will enable the create agent button. |
| `features` | ``map (key: string, value: enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.FeatureState`))`` 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` - `speech-to-text` - `feedback` - `session-sharing` - `personalization-memory` - `personalization-suggested-highlights` - `mobile-app-access` - `disable-agent-sharing` - `disable-image-generation` - `disable-video-generation` - `disable-onedrive-upload` - `disable-talk-to-content` - `disable-google-drive-upload` - `disable-welcome-emails` - `disable-canvas` - `canvas-workspace` - `canvas-app-builder` - `skills` - `skill-sharing` - `skill-sharing-without-admin-approval` - `disable-projects` - `sobi` - `enable-end-user-sharing-with-groups` - `single-agent-orchestration` - `multi-agent-orchestration` - `cross-product-intelligence` - `workflow-agents` - `in-app-notifications` |
| `modelConfigs` | ``map (key: string, value: enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ModelState`))`` Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or modelConfigs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. |
| `searchAddonSpec` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.SearchAddonSpec`)`` Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. |
| `modelConfigInfo` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ModelConfigInfo`)`` Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `modelConfigs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. |
| `sourceAdminDisplayNameEnabled` | `boolean` Optional. Whether to show the admin-configured display name for data connectors in the widget sources UI (instead of the connector kind). Opt-in; defaults to false. |
| `onedrivePickerEnabled` | `boolean` Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). |
| `googleDrivePickerEnabled` | `boolean` Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrivePickerEnabled` above. |

### InteractionType

Describes interaction type.

| Enums ||
|---|---|
| `INTERACTION_TYPE_UNSPECIFIED` | Not specified. Defaults to SEARCH_ONLY. |
| `SEARCH_ONLY` | Search without a generative answer. |
| `SEARCH_WITH_ANSWER` | Search with the generative answer. |
| `SEARCH_WITH_FOLLOW_UPS` | Search with the generative answer that supports follow up questions. Also known as multi-turn search. |

### GenerativeAnswerConfig

Describes configuration for generative answer.

| JSON representation |
|---|
| ``` { "resultCount": integer, "modelVersion": string, "modelPromptPreamble": string, "maxRephraseSteps": integer, "languageCode": string, "disableRelatedQuestions": boolean, "ignoreNonAnswerSeekingQuery": boolean, "ignoreAdversarialQuery": boolean, "ignoreLowRelevantContent": boolean, "imageSource": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ImageSource`) } ``` |

| Fields ||
|---|---|
| `resultCount` | `integer` The number of top results to generate the answer from. Up to 10. |
| `modelVersion` | `string` The model version used to generate the answer. |
| `modelPromptPreamble` | `string` Text at the beginning of the prompt that instructs the model that generates the answer. |
| `maxRephraseSteps` | `integer` Max rephrase steps. The max number is 5 steps. If not set or set to \< 1, it will be set to 1 by default. |
| `languageCode` | `string` Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. |
| `disableRelatedQuestions` | `boolean` Whether generated answer contains suggested related questions. |
| `ignoreNonAnswerSeekingQuery` | `boolean` Optional. Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. |
| `ignoreAdversarialQuery` | `boolean` Optional. Specifies whether to filter out queries that are adversarial. |
| `ignoreLowRelevantContent` | `boolean` Optional. Specifies whether to filter out queries that are not relevant to the content. |
| `imageSource` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ImageSource`)`` Optional. Source of image returned in the answer. |

### ImageSource

Source of image returned in the answer.

| Enums ||
|---|---|
| `IMAGE_SOURCE_UNSPECIFIED` | Unspecified image source (multimodal feature is disabled by default) |
| `ALL_AVAILABLE_SOURCES` | Behavior when service determines the pick from all available sources. |
| `CORPUS_IMAGE_ONLY` | Include image from corpus in the answer. |
| `FIGURE_GENERATION_ONLY` | Triggers figure generation in the answer. |

### FeatureState

The state of the feature for the engine.

| Enums ||
|---|---|
| `FEATURE_STATE_UNSPECIFIED` | The feature state is unspecified. |
| `FEATURE_STATE_ON` | The feature is turned on to be accessible. |
| `FEATURE_STATE_OFF` | The feature is turned off to be inaccessible. |

### ModelState

The state of the model for the engine.

| Enums ||
|---|---|
| `MODEL_STATE_UNSPECIFIED` | The model state is unspecified. |
| `MODEL_ENABLED` | The model is enabled by admin. |
| `MODEL_DISABLED` | The model is disabled by admin. |

### SearchAddonSpec

SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.

| JSON representation |
|---|
| ``` { "semanticAddOnDisabled": boolean, "kpiPersonalizationAddOnDisabled": boolean, "generativeAnswerAddOnDisabled": boolean } ``` |

| Fields ||
|---|---|
| `semanticAddOnDisabled` | `boolean` Optional. If true, semantic add-on is disabled. Semantic add-on includes embeddings and jetstream. |
| `kpiPersonalizationAddOnDisabled` | `boolean` Optional. If true, disables event re-ranking and personalization to optimize KPIs \& personalize results. |
| `generativeAnswerAddOnDisabled` | `boolean` Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. |

### ModelConfigInfo

The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `modelConfigs`.

The backend is the single source of truth for this configuration; clients should render `resolvedModels` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization.

| JSON representation |
|---|
| ``` { "resolvedModels": [ { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ResolvedModel`) } ], "defaultModelId": string, "autoModelId": string } ``` |

| Fields ||
|---|---|
| `resolvedModels[]` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ResolvedModel`)`` Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. |
| `defaultModelId` | `string` Output only. The `modelId` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `modelId`s present in `resolvedModels`. |
| `autoModelId` | `string` Output only. The `modelId` a client must send when the end-user picks the "Auto" entry (the empty `modelId`). Populated only for surfaces known to have no true "Auto" mode, where leaving the model unset would fall back to a platform default rather than a backend-chosen model. Empty on every other surface, where "Auto" is resolved server-side, and when none of the surface's ranked models is available. When set, it is always one of the non-empty `modelId`s present in `resolvedModels`. |

### ResolvedModel

A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata.

| JSON representation |
|---|
| ``` { "modelId": string, "displayName": string, "icon": string, "description": string, "isPreview": boolean, "label": string, "adminView": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AdminView`) }, "promoted": boolean, "iconUrl": string, "family": string } ``` |

| Fields ||
|---|---|
| `modelId` | `string` Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend. |
| `displayName` | `string` Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the `LookupWidgetConfigRequest.language_code` and `LookupWidgetConfigRequest.region_code` of the request. |
| `icon` | `string` Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). |
| `description` | `string` Output only. Localized description text (e.g. `state-of-the-art reasoning`). Localized using the same locale as `displayName`. |
| `isPreview` | `boolean` Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI. |
| `label` | `string` Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `displayName` (`Gemini 3.x Flash`). Falls back to `displayName` when the backend registry does not specify a distinct short label. |
| `adminView` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AdminView`)`` Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. |
| `promoted` | `boolean` Output only. Whether this model should be promoted in the GE chat homepage banner. |
| `iconUrl` | `string` Output only. Absolute URL of a brand mark to render instead of `icon`, for models whose vendor logo is not a GM3 glyph. `icon` stays populated as the fallback, so a client that does not render images, or that fails to fetch this one, shows the glyph instead of nothing. |
| `family` | `string` Output only. Groups models that render together in the selector. Models sharing a value form one group; empty means the model belongs to no group. Compared for equality only -- never parsed, and never shown to a user, so it is not localized. |

### AdminView

Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry.

| JSON representation |
|---|
| ``` { "adminOverridable": boolean, "enabledByDefault": boolean, "regions": [ string ] } ``` |

| Fields ||
|---|---|
| `adminOverridable` | `boolean` Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabledByDefault`. |
| `enabledByDefault` | `boolean` Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. |
| `regions[]` | `string` Output only. Regions where this model is launched. |

### AccessSettings

Describes widget access settings.

| JSON representation |
|---|
| ``` { "allowPublicAccess": boolean, "allowlistedDomains": [ string ], "enableWebApp": boolean, "workforceIdentityPoolProvider": string, "languageCode": string } ``` |

| Fields ||
|---|---|
| `allowPublicAccess` | `boolean` Whether public unauthenticated access is allowed. |
| `allowlistedDomains[]` | `string` List of domains that are allowed to integrate the search widget. |
| `enableWebApp` | `boolean` Whether web app access is enabled. |
| `workforceIdentityPoolProvider` | `string` Optional. The workforce identity pool provider used to access the widget. |
| `languageCode` | `string` Optional. Language code for user interface. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). If unset, the default language code is "en-US". |

### UiBrandingSettings

Describes widget UI branding settings.

| JSON representation |
|---|
| ``` { "logo": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Image`) } } ``` |

| Fields ||
|---|---|
| `logo` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Image`)`` Logo image. |

### Image

Options to store an image.

| JSON representation |
|---|
| ``` { // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "url": string // End of mutually exclusive fields. } ``` |

| Fields ||
|---|---|
| Various ways to store an image, i.e., as a URL or base64 encoded string. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `url` | `string` Image URL. |
| End of mutually exclusive fields. ||

### HomepageSetting

Describes the homepage setting of the widget. It includes all homepage related settings and configurations, such as shortcuts.

| JSON representation |
|---|
| ``` { "shortcuts": [ { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Shortcut`) } ] } ``` |

| Fields ||
|---|---|
| `shortcuts[]` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Shortcut`)`` Optional. The shortcuts to display on the homepage. |

### Shortcut

Describes an entity of shortcut (aka pinned content) on the homepage. The home page will render these shortcuts in the same order as what the API returns. If a customer wants to reorder or remove a shortcut, the UI should always provide the new full list of shortcuts.

| JSON representation |
|---|
| ``` { "title": string, "icon": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Image`) }, "destinationUri": string } ``` |

| Fields ||
|---|---|
| `title` | `string` Optional. Title of the shortcut. |
| `icon` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Image`)`` Optional. Icon URL of shortcut. |
| `destinationUri` | `string` Optional. Destination URL of shortcut. |

### AssistantSettings

Describes the assistant settings of the widget.

| JSON representation |
|---|
| ``` { "googleSearchGroundingEnabled": boolean, "webGroundingType": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.WebGroundingType`), "defaultWebGroundingToggleOff": boolean, "disableLocationContext": boolean, "mapsGroundingType": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.MapsGroundingType`), "defaultMapsGroundingToggleOff": boolean } ``` |

| Fields ||
|---|---|
| `googleSearchGroundingEnabled (deprecated)` | `boolean` > [!WARNING] > This item is deprecated! Whether or not the Google search grounding toggle is shown. Deprecated. Use `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.AssistantSettings.FIELDS.web_grounding_type` instead. |
| `webGroundingType` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.WebGroundingType`)`` Optional. The type of web grounding to use. |
| `defaultWebGroundingToggleOff` | `boolean` Output only. This field controls the default web grounding toggle for end users if `webGroundingType` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `webGroundingType` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. |
| `disableLocationContext` | `boolean` Optional. Output only. Whether to disable user location context. |
| `mapsGroundingType` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.MapsGroundingType`)`` Optional. The type of Google Maps grounding to use. |
| `defaultMapsGroundingToggleOff` | `boolean` Output only. This field controls the default maps grounding toggle for end users if `mapsGroundingType` is set to `MAPS_GROUNDING_TYPE_GOOGLE_MAPS`. By default, this field is set to false. If `mapsGroundingType` is `MAPS_GROUNDING_TYPE_GOOGLE_MAPS`, end users will have maps grounding enabled by default on UI. If true, the grounding toggle will default to the OFF position in the UI. End users can still enable maps grounding in the UI if maps grounding is enabled. |

### WebGroundingType

The type of web grounding to use.

| Enums ||
|---|---|
| `WEB_GROUNDING_TYPE_UNSPECIFIED` | Default, unspecified setting. This is the same as disabled. |
| `WEB_GROUNDING_TYPE_DISABLED` | Web grounding is disabled. |
| `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` | Grounding with Google Search is enabled. |
| `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH` | Grounding with Enterprise Web Search is enabled. |

### MapsGroundingType

The type of Google Maps grounding to use.

| Enums ||
|---|---|
| `MAPS_GROUNDING_TYPE_UNSPECIFIED` | Default, unspecified setting. This is the same as disabled. |
| `MAPS_GROUNDING_TYPE_DISABLED` | Maps grounding is disabled. |
| `MAPS_GROUNDING_TYPE_GOOGLE_MAPS` | Grounding with Google Maps is enabled. |

### CustomerProvidedConfig

Customer provided configurations.

| JSON representation |
|---|
| ``` { "customerType": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CustomerType`), "complianceLevel": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ComplianceLevel`) } ``` |

| Fields ||
|---|---|
| `customerType` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.CustomerType`)`` Customer type. |
| `complianceLevel` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ComplianceLevel`)`` Output only. The customer's Assured Workloads compliance level. `customerType` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. |

### CustomerType

Customer type.

| Enums ||
|---|---|
| `DEFAULT_CUSTOMER` | Default customer type. |
| `GOVERNMENT_CUSTOMER` | Government customer type. Some features are disabled for government customers due to legal requirements. |

### ComplianceLevel

Assured Workloads compliance level of the customer's project.

Not frozen: further levels may be added as more compliance regimes are supported, so a client must treat an unrecognized value as government-restricted rather than as unrestricted.

| Enums ||
|---|---|
| `COMPLIANCE_LEVEL_UNSPECIFIED` | The project has no Assured Workloads compliance level, or reports one that this API version does not model. |
| `COMPLIANCE_LEVEL_FEDRAMP_HIGH` | FedRAMP High compliance level. |
| `COMPLIANCE_LEVEL_IL4` | Impact Level 4 (IL4) compliance level. |
| `COMPLIANCE_LEVEL_IL5` | Impact Level 5 (IL5) compliance level. |

### BatchAuthStatus

Describes the batch authorization status for a batchAuthorizationGroup.

| JSON representation |
|---|
| ``` { "placeholder": string, "batchAuthorizationGroup": string, "connectorAuthState": { object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ConnectorAuthState`) } } ``` |

| Fields ||
|---|---|
| `placeholder` | `string` Output only. It is the batch authorization group placeholder full resource name. This is not a real data connector (not existed in DataConnector table in spanner). It's a resource name existing only in the connector_authorization in the user table. E.g. projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector. |
| `batchAuthorizationGroup` | `string` Output only. The batch authorization group the placeholder belongs to. |
| `connectorAuthState` | ``object (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.ConnectorAuthState`)`` Output only. The current authorization state for this connector. |

### Node

Represents a single reusable computational or logical unit.

| JSON representation |
|---|
| ``` { "displayName": string, "iconUrl": string, "description": string, "parameterSchema": { object }, "outputSchema": { object }, "type": enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Type`) } ``` |

| Fields ||
|---|---|
| `displayName` | `string` Output only. A human readable name for the node. |
| `iconUrl` | `string` Output only. An identifier or URL pointing to an icon representing this node type. |
| `description` | `string` Output only. A detailed description of what the node does. |
| `parameterSchema` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` Output only. The parameter schema of the tool. This schema is expected to conform to the OpenAPI Schema standard (see <https://spec.openapis.org/oas/v3.0.3.html> and AIP-146). It describes the expected structure of the parameters that this node accepts. |
| `outputSchema` | ``object (`https://protobuf.dev/reference/protobuf/google.protobuf#struct` format)`` Output only. The output schema of the tool. This schema is expected to conform to the OpenAPI Schema standard (see <https://spec.openapis.org/oas/v3.0.3.html/> and AIP-146). It describes the structure of the output produced by this node. |
| `type` | ``enum (`https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig.Type`)`` Output only. The type of the node. |

### Type

Identifies the type of the node in the agent flow.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Unspecified type. |
| `TRIGGER` | Trigger type. |
| `FLOW` | flow type. |
| `CONNECTOR` | Connector type. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs/get` | Gets a `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs#WidgetConfig`. |
| ### `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.widgetConfigs/patch` | Update a WidgetConfig. |