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.VARIANTProducts sharing the same
Product.Type.PRIMARYProduct. For example:
primary_product_id = "some_product_id"
List Products bundled in a
Product.Type.COLLECTIONProduct.
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.PRIMARYProduct or
Product.Type.COLLECTIONProduct does not exist, a NOT_FOUND
error is returned.
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.VARIANTProducts sharing the same
Product.Type.PRIMARYProduct. For example:
primary_product_id = "some_product_id"
List Products bundled in a
Product.Type.COLLECTIONProduct.
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.PRIMARYProduct or
Product.Type.COLLECTIONProduct does not exist, a NOT_FOUND
error is returned.
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.
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.
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.
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.
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.
The fields of Product to return in
the responses. If not set or empty, the following fields are returned:
Product.name
Product.id
Product.title
Product.uri
Product.images
Product.price_info
Product.brands
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.
The fields of Product to return in
the responses. If not set or empty, the following fields are returned:
Product.name
Product.id
Product.title
Product.uri
Product.images
Product.price_info
Product.brands
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.
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.
The fields of Product to return in
the responses. If not set or empty, the following fields are returned:
Product.name
Product.id
Product.title
Product.uri
Product.images
Product.price_info
Product.brands
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-21 UTC."],[],[]]
