list method
Lists the processed products in your Merchant Center account.
The response might contain fewer items than specified by pageSize
. Rely
on pageToken
to determine if there are more items to be requested. After
inserting, updating, or deleting a product input, it may take several
minutes before the updated processed product can be retrieved.
Request parameters:
parent
- Required. The account to list processed products for. Format:
accounts/{account}
Value must have pattern ^accounts/\[^/\]+$
.
pageSize
- The maximum number of products to return. The service may
return fewer than this value. The maximum value is 1000; values above 1000
will be coerced to 1000. If unspecified, the default page size of 25
products will be returned.
pageToken
- A page token, received from a previous ListProducts
call.
Provide this to retrieve the subsequent page. When paginating, all other
parameters provided to ListProducts
must match the call that provided
the page token.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListProductsResponse.
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<ListProductsResponse> list(
core.String parent, {
core.int? pageSize,
core.String? pageToken,
core.String? $fields,
}) async {
final queryParams_ = <core.String, core.List<core.String>>{
if (pageSize != null) 'pageSize': ['${pageSize}'],
if (pageToken != null) 'pageToken': [pageToken],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'products/v1/' + core.Uri.encodeFull('$parent') + '/products';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListProductsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>,
);
}