list method
Lists location lists based on a given advertiser id.
Request parameters:
advertiserId
- Required. The ID of the DV360 advertiser to which the
fetched location lists belong.
Value must have pattern ^\[^/\]+$
.
filter
- Allows filtering by location list fields. Supported syntax: *
Filter expressions are made up of one or more restrictions. * Restrictions
can be combined by AND
or OR
logical operators. A sequence of
restrictions implicitly uses AND
. * A restriction has the form of
{field} {operator} {value}
. * All fields must use the EQUALS (=)
operator. Supported fields: * locationType
Examples: * All regional
location list: locationType="TARGETING_LOCATION_TYPE_REGIONAL"
* All
proximity location list:
locationType="TARGETING_LOCATION_TYPE_PROXIMITY"
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: *
locationListId
(default) * displayName
The default sorting order is
ascending. To specify descending order for a field, a suffix "desc" should
be added to the field name. Example: displayName desc
.
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 ListLocationLists
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 ListLocationListsResponse.
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<ListLocationListsResponse> list(
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 (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/advertisers/' +
core.Uri.encodeFull('$advertiserId') +
'/locationLists';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListLocationListsResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}