list method

Future<UrlChannels> list(
  1. String adClientId, {
  2. int? maxResults,
  3. String? pageToken,
  4. String? $fields,
})

List all host URL channels in the host AdSense account.

Request parameters:

adClientId - Ad client for which to list URL channels.

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

pageToken - A continuation token, used to page through URL channels. 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 UrlChannels.

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

  final url_ =
      'adclients/' + commons.escapeVariable('$adClientId') + '/urlchannels';

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