Important: There is a newer version of this product and documentation. You are currently viewing the v1beta1 Recommendations Engine API documentation, which remains available but will no longer be updated.

See Migrating to the Retail API from beta in the new documentation.

Method: projects.locations.catalogs.catalogItems.list

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

Gets a list of catalog items.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog.

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

  • automlrecommendations.catalogItems.list

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of results to return per page. If zero, the service will choose a reasonable default.
pageToken

string

Optional. The previous ListCatalogItemsResponse.next_page_token.
filter

string

Optional. Use of this field is not supported by version v1beta1.

Request body

The request body must be empty.

Response body

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

Response message for catalogItems.list method.

JSON representation 
{
  "catalogItems": [
    {
      object (CatalogItem)
    }
  ],
  "nextPageToken": string
}
Fields
catalogItems[]

object (CatalogItem)

The catalog items.
nextPageToken

string

If empty, the list is complete. If nonempty, the token to pass to the next request's ListCatalogItemRequest.page_token.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.