Method: projects.locations.dataStores.widgetConfigs.patch

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions

Update a WidgetConfig.

HTTP request

PATCH https://discoveryengine.googleapis.com/v1alpha/{widgetConfig.name=projects/*/locations/*/dataStores/*/widgetConfigs/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
widgetConfig.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.

Query parameters

Parameters
updateMask	string (FieldMask format) 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. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of WidgetConfig.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

• discoveryengine.widgetConfigs.update

For more information, see the IAM documentation.