- [Resource: WidgetConfig](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.engines.widgetConfigs#WidgetConfig)
  - [JSON representation](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.engines.widgetConfigs#WidgetConfig.SCHEMA_REPRESENTATION)
- [Methods](https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.engines.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. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/gemini/enterprise/docs/reference/rest/v1alpha/projects.locations.collections.engines.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.engines.widgetConfigs/patch` | Update a WidgetConfig. |