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

Method: projects.locations.catalogs.attributesConfig.replaceCatalogAttribute

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

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
attributesConfig

string

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

Request body

The request body contains data with the following structure:

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

object (CatalogAttribute)

Required. The updated CatalogAttribute.

updateMask

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:

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

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.