This is the documentation for Recommendations AI, Retail Search, and the new Retail console.

Method: projects.locations.catalogs.controls.patch

Updates a Control.

Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to delete does not exist, a NOT_FOUND error is returned.

HTTP request

PATCH https://retail.googleapis.com/v2alpha/{control.name=projects/*/locations/*/catalogs/*/controls/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
control.name

string

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

Query parameters

Parameters
updateMask

string (FieldMask format)

Indicates which fields in the provided Control to update. The following are NOT supported:

If not set or empty, 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 Control.

Response body

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

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:

  • retail.controls.update

For more information, see the IAM documentation.