Method: projects.locations.catalogs.attributesConfig.addCatalogAttribute

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

Adds the specified CatalogAttribute to the AttributesConfig.

If the CatalogAttribute to add already exists, an ALREADY_EXISTS 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)

object (CatalogAttribute)

Required. The CatalogAttribute to add.

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

For more information, see the IAM documentation.