Method: projects.locations.catalogs.controls.create

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

Creates a Control.

If the Control to create already exists, an ALREADY_EXISTS error is returned.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{locationId}/catalogs/{catalogId}

Query parameters



Required. The ID to use for the Control, which will become the final component of the Control's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.

Request body

The request body contains an instance of Control.

Response body

If successful, the response body contains a newly created instance of Control.

Authorization Scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • retail.controls.create

For more information, see the IAM documentation.