list method

Future<AdUnits> list(
  1. String accountId,
  2. String adClientId, {
  3. bool? includeInactive,
  4. int? maxResults,
  5. String? pageToken,
  6. String? $fields,
})

List all ad units in the specified publisher's AdSense account.

Request parameters:

accountId - Account which contains the ad client.

adClientId - Ad client for which to list ad units.

includeInactive - Whether to include inactive ad units. Default: true.

maxResults - The maximum number of ad units to include in the response, used for paging. Value must be between "0" and "10000".

pageToken - A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

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

Completes with a AdUnits.

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<AdUnits> list(
  core.String accountId,
  core.String adClientId, {
  core.bool? includeInactive,
  core.int? maxResults,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (includeInactive != null) 'includeInactive': ['${includeInactive}'],
    if (maxResults != null) 'maxResults': ['${maxResults}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'accounts/' +
      commons.escapeVariable('$accountId') +
      '/adclients/' +
      commons.escapeVariable('$adClientId') +
      '/adunits';

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