Method: catalogs.products.list

Lists Product resources that the producer has access to, within the scope of the parent catalog.

HTTP request

GET https://cloudprivatecatalogproducer.googleapis.com/v1beta1/{parent=catalogs/*}/products

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The resource name of the parent resource.

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

  • cloudprivatecatalogproducer.catalogs.get

Query parameters

Parameters
pageSize

number

The maximum number of products to return.

filter

string

A filter expression used to restrict the returned results based upon properties of the product.

pageToken

string

A pagination token returned from a previous call to products.list that indicates where this listing should continue from. This field is optional.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "products": [
    {
      object(Product)
    }
  ],
  "nextPageToken": string
}
Fields
products[]

object(Product)

The Product returned from the list call.

nextPageToken

string

A pagination token returned from a previous call to products.list that indicates where the listing should continue from. This field is optional.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

Try it!