Method: projects.locations.catalogs.attributesConfig.replaceCatalogAttribute

Stay organized with collections Save and categorize content based on your preferences.

Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key.

If the CatalogAttribute to replace does not exist, a NOT_FOUND error is returned.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Full AttributesConfig resource name. Format: projects/{projectNumber}/locations/{locationId}/catalogs/{catalogId}/attributesConfig

Request body

The request body contains data with the following structure:

JSON representation
  "catalogAttribute": {
    object (CatalogAttribute)
  "updateMask": string

object (CatalogAttribute)

Required. The updated CatalogAttribute.


string (FieldMask format)

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

If not set, all supported fields are updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Response body

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

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the attributesConfig resource:

  • retail.attributesConfigs.replaceCatalogAttribute

For more information, see the IAM documentation.