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

Method: projects.locations.catalogs.attributesConfig.batchRemoveCatalogAttributes

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

Removes all specified CatalogAttributes from the AttributesConfig.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
attributesConfig

string

Required. The attributes config resource shared by all catalog attributes being deleted. Format: projects/{project_number}/locations/{locationId}/catalogs/{catalogId}/attributesConfig

Request body

The request body contains data with the following structure:

JSON representation
{
  "attributeKeys": [
    string
  ]
}
Fields
attributeKeys[]

string

Required. The attribute name keys of the CatalogAttributes to delete. A maximum of 1000 catalog attributes can be deleted in a batch.

Response body

If successful, the response body contains data with the following structure:

Response of the CatalogService.BatchRemoveCatalogAttributes.

JSON representation
{
  "deletedCatalogAttributes": [
    string
  ],
  "resetCatalogAttributes": [
    string
  ]
}
Fields
deletedCatalogAttributes[]

string

Catalog attributes that were deleted. Only pre-loaded [catalog attributes][CatalogAttribute] that are neither in use by products nor predefined can be deleted.

resetCatalogAttributes[]

string

Catalog attributes that were reset. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request.

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

For more information, see the IAM documentation.