list method
Gets a list of Products.
Request parameters:
parent
- Required. The parent branch resource name, such as `projects /
- /locations/global/catalogs/default_catalog/branches/0
. Use
default_branchas 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. Value must have pattern
^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+$`.
filter
- 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.
pageSize
- 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
- 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.
readMask
- 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.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a GoogleCloudRetailV2ListProductsResponse.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<GoogleCloudRetailV2ListProductsResponse> list(
core.String parent, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
core.String? readMask,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (filter != null) 'filter': [filter],
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if (readMask != null) 'readMask': [readMask],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'v2/' + core.Uri.encodeFull('$parent') + '/products';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudRetailV2ListProductsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}