list method

Future<ListSitesResponse> list(String partnerId, String channelId, { String? advertiserId, String? filter, String? orderBy, int? pageSize, String? pageToken, String? $fields, })

Lists sites in a channel.

Request parameters:

partnerId - The ID of the partner that owns the parent channel. Value must have pattern ^\[^/\]+$.

channelId - Required. The ID of the parent channel to which the requested sites belong. Value must have pattern ^\[^/\]+$.

advertiserId - The ID of the advertiser that owns the parent channel.

filter - Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of {field} {operator} {value}. * All fields must use the HAS (:) operator. Supported fields: * urlOrAppId Examples: * All sites for which the URL or app ID contains "google": urlOrAppId : "google" The length of this field should be no more than 500 characters. Reference our [filter LIST requests](/display-video/api/guides/how-tos/filters) guide for more information.

orderBy - Field by which to sort the list. Acceptable values are: * urlOrAppId (default) The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: urlOrAppId desc.

pageSize - Requested page size. Must be between 1 and 10000. If unspecified will default to 100. 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 ListSites 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 ListSitesResponse.

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<ListSitesResponse> list(
  core.String partnerId,
  core.String channelId, {
  core.String? advertiserId,
  core.String? filter,
  core.String? orderBy,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (advertiserId != null) 'advertiserId': [advertiserId],
    if (filter != null) 'filter': [filter],
    if (orderBy != null) 'orderBy': [orderBy],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2/partners/' +
      core.Uri.encodeFull('$partnerId') +
      '/channels/' +
      core.Uri.encodeFull('$channelId') +
      '/sites';

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