Method: projects.locations.collections.engines.widgetConfigs.get

Gets a WidgetConfig.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/widgetConfigs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Full WidgetConfig resource name. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

Query parameters

Parameters
acceptCache

boolean

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.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of WidgetConfig.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.widgetConfigs.get

For more information, see the IAM documentation.