2025-11-11
▼ ▲ discoveryengine.projects.locations.collections.dataStores.widgetConfigs.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$
Location : path
Required : Yes
Type : string
acceptCache
Description : Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
Location : query
Type : boolean
getWidgetConfigRequestOption.turnOffCollectionComponents
Description : Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
Location : query
Type : boolean
Parameter Order : name
Scopes :
Description : Gets a WidgetConfig.
▼ ▲ discoveryengine.projects.locations.collections.dataStores.widgetConfigs.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. 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.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Update a WidgetConfig.
▼ ▲ discoveryengine.projects.locations.collections.engines.widgetConfigs.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$
Location : path
Required : Yes
Type : string
acceptCache
Description : Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
Location : query
Type : boolean
getWidgetConfigRequestOption.turnOffCollectionComponents
Description : Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
Location : query
Type : boolean
Parameter Order : name
Scopes :
Description : Gets a WidgetConfig.
▼ ▲ discoveryengine.projects.locations.collections.engines.widgetConfigs.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. 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.
Pattern : ^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Update a WidgetConfig.
▼ ▲ discoveryengine.projects.locations.dataStores.widgetConfigs.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}
HTTP Method : GET
Parameters :
name
Description : Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$
Location : path
Required : Yes
Type : string
acceptCache
Description : Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.
Location : query
Type : boolean
getWidgetConfigRequestOption.turnOffCollectionComponents
Description : Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.
Location : query
Type : boolean
Parameter Order : name
Scopes :
Description : Gets a WidgetConfig.
▼ ▲ discoveryengine.projects.locations.dataStores.widgetConfigs.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/widgetConfigs/{widgetConfigsId}
HTTP Method : PATCH
Parameters :
name
Description : Immutable. 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.
Pattern : ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/widgetConfigs/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes :
Description : Update a WidgetConfig.
▼ ▲ discoveryengine.projects.locations.userStores.licenseConfigsUsageStats.list
Path : v1/{+parent}/licenseConfigsUsageStats
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/licenseConfigsUsageStats
HTTP Method : GET
Parameters :
parent
Description : Required. The parent branch resource name, such as `projects/{project}/locations/{location}/userStores/{user_store_id}`.
Pattern : ^projects/[^/]+/locations/[^/]+/userStores/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : parent
Scopes :
Description : Lists all the LicenseConfigUsageStatss associated with the project.