Method: projects.locations.catalogs.list

Lists all the Catalog s associated with the project.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`parent`	`string` Required. The account resource name with an associated location. If the caller does not have permission to list `Catalog` s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

parent

string

Required. The account resource name with an associated location.

If the caller does not have permission to list Catalog s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

Query parameters

Parameters

Parameters
`pageSize`	`integer` Maximum number of `Catalog` s to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT is returned.
`pageToken`	`string` A page token `ListCatalogsResponse.next_page_token` , received from a previous `CatalogService.ListCatalogs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `CatalogService.ListCatalogs` must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

pageSize

integer

Maximum number of Catalog s to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT is returned.

pageToken

string

A page token ListCatalogsResponse.next_page_token , received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Request body

The request body must be empty.

Response body

Response for CatalogService.ListCatalogs method.

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

JSON representation
{ "catalogs" : [ { object ( `Catalog` ) } ] , "nextPageToken" : string }

Fields

Fields
`catalogs[]`	`object ( Catalog )` All the customer's `Catalog` s.
`nextPageToken`	`string` A token that can be sent as `ListCatalogsRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

catalogs[]

object ( Catalog )

All the customer's Catalog s.

nextPageToken

string

A token that can be sent as ListCatalogsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

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.catalogs.list

For more information, see the IAM documentation .