Class ListProductsRequest (1.20.0)

ListProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for ProductService.ListProducts method.


parent str
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.
page_size int
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.
page_token str
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 str
A filter to apply on the list results. Supported features: - List all the products under the parent branch if filter is unset. - List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id" - List Products bundled in a Product.Type.COLLECTION Product. For example: collection_product_id = "some_product_id" - List Products with a partibular type. For example: type = "PRIMARY" type = "VARIANT" type = "COLLECTION" 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.
read_mask google.protobuf.field_mask_pb2.FieldMask
The fields of Product to return in the responses. If not set or empty, the following fields are returned: - - - Product.title - Product.uri - Product.images - Product.price_info - Product.brands If "*" is provided, all fields are returned. is always returned no matter what mask is set. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
require_total_size bool
If true and page_token is empty, ListProductsResponse.total_size is set to the total count of matched items irrespective of pagination. Notice that setting this field to true affects the performance.