list method
Lists advertisers that are accessible to the current user.
The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported.
Request parameters:
filter
- Allows filtering by advertiser fields. Supported syntax: *
Filter expressions are made up of one or more restrictions. * Restrictions
can be combined by AND
or OR
logical operators. * A restriction has
the form of {field} {operator} {value}
. * The updateTime
field must
use the GREATER THAN OR EQUAL TO (>=)
or LESS THAN OR EQUAL TO (<=)
operators. * All other fields must use the EQUALS (=)
operator.
Supported fields: * advertiserId
* displayName
* entityStatus
*
updateTime
(input in ISO 8601 format, or YYYY-MM-DDTHH:MM:SSZ
)
Examples: * All active advertisers under a partner:
entityStatus="ENTITY_STATUS_ACTIVE"
* All advertisers with an update
time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601):
updateTime<="2020-11-04T18:54:47Z"
* All advertisers with an update time
greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601):
updateTime>="2020-11-04T18:54:47Z"
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: *
displayName
(default) * entityStatus
* updateTime
The default
sorting order is ascending. To specify descending order for a field, a
suffix "desc" should be added to the field name. For example, displayName desc
.
pageSize
- Requested page size. Must be between 1
and 200
. If
unspecified will default to 100
.
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 ListAdvertisers
method. If not specified, the first
page of results will be returned.
partnerId
- Required. The ID of the partner that the fetched advertisers
should all belong to. The system only supports listing advertisers for one
partner at a time.
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a ListAdvertisersResponse.
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<ListAdvertisersResponse> list({
core.String? filter,
core.String? orderBy,
core.int? pageSize,
core.String? pageToken,
core.String? partnerId,
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 (partnerId != null) 'partnerId': [partnerId],
if ($fields != null) 'fields': [$fields],
};
const url_ = 'v2/advertisers';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListAdvertisersResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}