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

Method: projects.locations.catalogs.attributesConfig.removeCatalogAttribute

Removes the specified CatalogAttribute from the AttributesConfig.

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

HTTP request

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

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
{
  "key": string
}
Fields
key

string

Required. The attribute name key of the CatalogAttribute to remove.

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

For more information, see the IAM documentation.