Method: projects.locations.catalogs.updateAttributesConfig

Updates the AttributesConfig.

The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.

HTTP request

PATCH https://retail.googleapis.com/v2beta/{attributesConfig.name=projects/*/locations/*/catalogs/*/attributesConfig}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
attributesConfig.name

string

Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig

Query parameters

Parameters
updateMask

string (FieldMask format)

Indicates which fields in the provided AttributesConfig to update. The following is the only supported field:

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 AttributesConfig.

Response body

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

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.attributesConfigs.update

For more information, see the IAM documentation.