This is the unified documentation for Retail API. This includes Recommendations AI, Retail Search, and the unified Retail console (which is applicable to both Recommendations AI and Retail Search users). To use the new console or Retail Search while they are in the restricted GA phase, submit a form here to contact Cloud sales. If you are using the v1beta version of Recommendations AI, migrate to the GA version: Migrating to the Retail API from beta.

To see documentation for only Recommendations AI and the Recommendations AI-only console, go to the How-to guides for Recommendations AI and the API reference documentation for Recommendations AI.

Method: projects.locations.catalogs.list

Lists all the Catalogs associated with the project.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The account resource name with an associated location.

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

Query parameters

Parameters
pageSize

integer

Maximum number of Catalogs 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

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

Response for CatalogService.ListCatalogs method.

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

object (Catalog)

All the customer's Catalogs.

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.