Method: projects.locations.catalogs.branches.products.list

Gets a list of Products.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0. Use default_branch as the branch ID, to list products under the default branch.

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

Query parameters

Parameters
pageSize

integer

Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.
pageToken

string

A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
filter

string

A filter to apply on the list results. Supported features:

If the field is unrecognizable, an INVALID_ARGUMENT error is returned.

If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.
readMask

string (FieldMask format)

The fields of Product to return in the responses. If not set or empty, the following fields are returned:

If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body must be empty.

Response body

Response message for ProductService.ListProducts method.

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

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

object (Product)

The Products.
nextPageToken

string

A token that can be sent as ListProductsRequest.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.products.list

For more information, see the IAM documentation.