Method: projects.locations.catalogs.catalogItems.list

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. A filter to apply on the list results.

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.