Method: projects.locations.catalogs.controls.list

Lists all Controls by their parent Catalog .

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

The URL uses gRPC Transcoding syntax.

Parameters

Parameters
`parent`	`string` Required. The catalog resource name. Format: `projects/{projectNumber}/locations/{locationId}/catalogs/{catalogId}`

parent

string

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

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"'

The request body must be empty.

Response for controls.list method.

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

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

Fields

Fields
`controls[]`	`object ( Control )` All the Controls for a given catalog.
`nextPageToken`	`string` Pagination token, if not returned indicates the last page.

controls[]

object ( Control )

All the Controls for a given catalog.

nextPageToken

string

Pagination token, if not returned indicates the last page.

Requires the following OAuth scope:

For more information, see the Authentication Overview .

Requires the following IAM permission on the parent resource:

For more information, see the IAM documentation .