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

Method: projects.locations.catalogs.controls.list

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

Lists all Controls by their parent Catalog.

HTTP request

GET https://retail.googleapis.com/v2beta/{parent=projects/*/locations/*/catalogs/*}/controls

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.

pageToken

string

Optional. A page token, received from a previous controls.list call. Provide this to retrieve the subsequent page.

filter

string

Optional. A filter to apply on the list results. Supported features:

  • List all the products under the parent branch if filter is unset.
  • List controls that are used in a single ServingConfig: 'servingConfig = "boosted_home_page_cvr"'

Request body

The request body must be empty.

Response body

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

Response for controls.list method.

JSON representation
{
  "controls": [
    {
      object (Control)
    }
  ],
  "nextPageToken": string
}
Fields
controls[]

object (Control)

All the Controls for a given catalog.

nextPageToken

string

Pagination token, if not returned indicates the last page.

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 parent resource:

  • retail.controls.list

For more information, see the IAM documentation.