Important: There is a newer version of this product and documentation. You are currently viewing documentation for the beta version Recommendations AI.

We recommend migrating your recommendations to the GA Retail API (service endpoint https://retail.googleapis.com). The Recommendations Engine beta API (service endpoint https://recommendationengine.googleapis.com) and this documentation set remain available, but they will no longer be updated. See the new documentation:

Method: projects.locations.catalogs.list

Lists all the catalog configurations associated with the project.

HTTP request

GET https://recommendationengine.googleapis.com/v1beta1/{parent=projects/*/locations/*}/catalogs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The account resource name with an associated location.

Authorization requires the following IAM permission on the specified resource parent:

  • automlrecommendations.catalogs.list

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 catalogs.list call. Provide this to retrieve the subsequent page.

Request body

The request body must be empty.

Response body

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

Response for catalogs.list method.

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

object (Catalog)

Output only. All the customer's catalogs.

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.