Skip to main content

widget_configs

Creates, updates, deletes, gets or lists a widget_configs resource.

Overview​

Namewidget_configs
TypeResource
Idgoogle.discoveryengine.widget_configs

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringImmutable. The full resource name of the widget config. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
accessSettingsobjectWill be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties. (id: GoogleCloudDiscoveryengineV1WidgetConfigAccessSettings)
allowPublicAccessbooleanWhether 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.
allowlistedDomainsarrayAllowlisted domains that can load this widget.
assistantSettingsobjectOptional. Output only. Describes the assistant settings of the widget. (id: GoogleCloudDiscoveryengineV1WidgetConfigAssistantSettings)
collectionComponentsarrayOutput 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.
configIdstringOutput only. Unique obfuscated identifier of a WidgetConfig.
contentSearchSpecobjectThe content search spec that configs the desired behavior of content search. (id: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec)
createTimestring (google-datetime)Output only. Timestamp the WidgetConfig was created.
customerProvidedConfigobjectOptional. Output only. Describes the customer related configurations, currently only used for government customers. This field cannot be modified after project onboarding. (id: GoogleCloudDiscoveryengineV1WidgetConfigCustomerProvidedConfig)
dataStoreTypestringOutput only. The type of the parent data store.
dataStoreUiConfigsarrayConfigurable UI configurations per data store.
defaultSearchRequestOrderBystringThe 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
displayNamestringRequired. 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.
enableAutocompletebooleanWhether or not to enable autocomplete.
enableConversationalSearchbooleanWhether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn).
enablePrivateKnowledgeGraphbooleanOptional. Output only. Whether to enable private knowledge graph.
enableQualityFeedbackbooleanTurn on or off collecting the search result quality feedback from end users.
enableResultScorebooleanWhether to show the result score.
enableSafeSearchbooleanWhether to enable safe search.
enableSearchAsYouTypebooleanWhether to enable search-as-you-type behavior for the search widget
enableSnippetResultSummarybooleanTurn on or off summary for each snippets result.
enableSummarizationbooleanTurn on or off summarization for the search response.
enableWebAppbooleanWhether to enable standalone web app.
facetFieldarrayThe configuration and appearance of facets in the end user view.
fieldsUiComponentsMapobjectThe 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.
geminiBundlebooleanOutput only. Whether the subscription is gemini bundle or not.
homepageSettingobjectOptional. Describes the homepage settings of the widget. (id: GoogleCloudDiscoveryengineV1WidgetConfigHomepageSetting)
industryVerticalstringOutput only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine.
llmEnabledbooleanOutput only. Whether LLM is enabled in the corresponding data store.
minimumDataTermAcceptedbooleanOutput only. Whether the customer accepted data use terms.
resultDisplayTypestringThe 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.
solutionTypestringRequired. Immutable. Specifies the solution type that this WidgetConfig can be used for.
uiBrandingobjectDescribes search widget UI branding settings, such as the widget title, logo, favicons, and colors. (id: GoogleCloudDiscoveryengineV1WidgetConfigUiBrandingSettings)
uiSettingsobjectDescribes general widget search settings as seen in cloud console widget configuration page. Replaces top deprecated top level properties. (id: GoogleCloudDiscoveryengineV1WidgetConfigUiSettings)
updateTimestring (google-datetime)Output only. Timestamp the WidgetConfig was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
projects_locations_collections_engines_widget_configs_getselectprojectsId, locationsId, collectionsId, enginesId, widgetConfigsIdacceptCache, getWidgetConfigRequestOption.turnOffCollectionComponentsGets a WidgetConfig.
projects_locations_collections_data_stores_widget_configs_getselectprojectsId, locationsId, collectionsId, dataStoresId, widgetConfigsIdacceptCache, getWidgetConfigRequestOption.turnOffCollectionComponentsGets a WidgetConfig.
projects_locations_data_stores_widget_configs_getselectprojectsId, locationsId, dataStoresId, widgetConfigsIdacceptCache, getWidgetConfigRequestOption.turnOffCollectionComponentsGets a WidgetConfig.
projects_locations_collections_engines_widget_configs_patchupdateprojectsId, locationsId, collectionsId, enginesId, widgetConfigsIdupdateMaskUpdate a WidgetConfig.
projects_locations_collections_data_stores_widget_configs_patchupdateprojectsId, locationsId, collectionsId, dataStoresId, widgetConfigsIdupdateMaskUpdate a WidgetConfig.
projects_locations_data_stores_widget_configs_patchupdateprojectsId, locationsId, dataStoresId, widgetConfigsIdupdateMaskUpdate a WidgetConfig.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
collectionsIdstring
dataStoresIdstring
enginesIdstring
locationsIdstring
projectsIdstring
widgetConfigsIdstring
acceptCacheboolean
getWidgetConfigRequestOption.turnOffCollectionComponentsboolean
updateMaskstring (google-fieldmask)

SELECT examples​

Gets a WidgetConfig.

SELECT
name,
accessSettings,
allowPublicAccess,
allowlistedDomains,
assistantSettings,
collectionComponents,
configId,
contentSearchSpec,
createTime,
customerProvidedConfig,
dataStoreType,
dataStoreUiConfigs,
defaultSearchRequestOrderBy,
displayName,
enableAutocomplete,
enableConversationalSearch,
enablePrivateKnowledgeGraph,
enableQualityFeedback,
enableResultScore,
enableSafeSearch,
enableSearchAsYouType,
enableSnippetResultSummary,
enableSummarization,
enableWebApp,
facetField,
fieldsUiComponentsMap,
geminiBundle,
homepageSetting,
industryVertical,
llmEnabled,
minimumDataTermAccepted,
resultDisplayType,
solutionType,
uiBranding,
uiSettings,
updateTime
FROM google.discoveryengine.widget_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND enginesId = '{{ enginesId }}' -- required
AND widgetConfigsId = '{{ widgetConfigsId }}' -- required
AND acceptCache = '{{ acceptCache }}'
AND getWidgetConfigRequestOption.turnOffCollectionComponents = '{{ getWidgetConfigRequestOption.turnOffCollectionComponents }}'
;

UPDATE examples​

Update a WidgetConfig.

UPDATE google.discoveryengine.widget_configs
SET 
data__resultDisplayType = '{{ resultDisplayType }}',
data__defaultSearchRequestOrderBy = '{{ defaultSearchRequestOrderBy }}',
data__allowPublicAccess = {{ allowPublicAccess }},
data__enableSnippetResultSummary = {{ enableSnippetResultSummary }},
data__allowlistedDomains = '{{ allowlistedDomains }}',
data__enableSearchAsYouType = {{ enableSearchAsYouType }},
data__contentSearchSpec = '{{ contentSearchSpec }}',
data__enableAutocomplete = {{ enableAutocomplete }},
data__enableWebApp = {{ enableWebApp }},
data__enableSummarization = {{ enableSummarization }},
data__enableSafeSearch = {{ enableSafeSearch }},
data__enableResultScore = {{ enableResultScore }},
data__uiSettings = '{{ uiSettings }}',
data__name = '{{ name }}',
data__fieldsUiComponentsMap = '{{ fieldsUiComponentsMap }}',
data__enableQualityFeedback = {{ enableQualityFeedback }},
data__uiBranding = '{{ uiBranding }}',
data__solutionType = '{{ solutionType }}',
data__accessSettings = '{{ accessSettings }}',
data__displayName = '{{ displayName }}',
data__dataStoreUiConfigs = '{{ dataStoreUiConfigs }}',
data__homepageSetting = '{{ homepageSetting }}',
data__enableConversationalSearch = {{ enableConversationalSearch }},
data__facetField = '{{ facetField }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND enginesId = '{{ enginesId }}' --required
AND widgetConfigsId = '{{ widgetConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
accessSettings,
allowPublicAccess,
allowlistedDomains,
assistantSettings,
collectionComponents,
configId,
contentSearchSpec,
createTime,
customerProvidedConfig,
dataStoreType,
dataStoreUiConfigs,
defaultSearchRequestOrderBy,
displayName,
enableAutocomplete,
enableConversationalSearch,
enablePrivateKnowledgeGraph,
enableQualityFeedback,
enableResultScore,
enableSafeSearch,
enableSearchAsYouType,
enableSnippetResultSummary,
enableSummarization,
enableWebApp,
facetField,
fieldsUiComponentsMap,
geminiBundle,
homepageSetting,
industryVertical,
llmEnabled,
minimumDataTermAccepted,
resultDisplayType,
solutionType,
uiBranding,
uiSettings,
updateTime;