list method
To retrieve the products that can be resold by the partner.
It should be autenticated with a service account.
Request parameters:
parent
- Required. The parent, the partner that can resell. Format:
partners/{partner}
Value must have pattern ^partners/\[^/\]+$
.
filter
- Optional. Specifies the filters for the product results. The
syntax is defined in https://google.aip.dev/160 with the following
caveats: 1. Only the following features are supported: - Logical operator
AND
- Comparison operator =
(no wildcards *
) - Traversal operator
.
- Has operator :
(no wildcards *
) 2. Only the following fields are
supported: - regionCodes
- youtubePayload.partnerEligibilityId
-
youtubePayload.postalCode
3. Unless explicitly mentioned above, other
features are not supported. Example: regionCodes:US AND youtubePayload.postalCode=94043 AND youtubePayload.partnerEligibilityId=eligibility-id
pageSize
- Optional. The maximum number of products to return. The
service may return fewer than this value. If unspecified, at most 50
products will be returned. The maximum value is 1000; values above 1000
will be coerced to 1000.
pageToken
- Optional. 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 GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse.
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<GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse>
list(
core.String parent, {
core.String? filter,
core.int? pageSize,
core.String? pageToken,
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 ($fields != null) 'fields': [$fields],
};
final url_ = 'v1/' + core.Uri.encodeFull('$parent') + '/products';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return GoogleCloudPaymentsResellerSubscriptionV1ListProductsResponse
.fromJson(response_ as core.Map<core.String, core.dynamic>);
}