list method

Future<ListBuyersResponse> list({
  1. int? pageSize,
  2. String? pageToken,
  3. String? $fields,
})

Lists all buyer account information the calling buyer user or service account is permissioned to manage.

Request parameters:

pageSize - The maximum number of buyers to return. If unspecified, at most 100 buyers will be returned. The maximum value is 500; values above 500 will be coerced to 500.

pageToken - A token identifying a page of results the server should return. This value is received from a previous ListBuyers call in ListBuyersResponse.nextPageToken.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListBuyersResponse.

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<ListBuyersResponse> list({
  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],
  };

  const url_ = 'v1/buyers';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListBuyersResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}