list method

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

Lists negative keyword lists based on a given advertiser id.

Request parameters:

advertiserId - Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. Value must have pattern ^\[^/\]+$.

pageSize - Requested page size. Must be between 1 and 200. Defaults to 100 if not set. Returns error code INVALID_ARGUMENT if an invalid value is specified.

pageToken - A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to ListNegativeKeywordLists method. If not specified, the first page of results will be returned.

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

Completes with a ListNegativeKeywordListsResponse.

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<ListNegativeKeywordListsResponse> list(
  core.String advertiserId, {
  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_ =
      'v3/advertisers/' +
      core.Uri.encodeFull('$advertiserId') +
      '/negativeKeywordLists';

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