list method
Lists manual triggers that are accessible to the current user for a given advertiser ID.
The order is defined by the order_by parameter. A single advertiser_id is required. Warning: Line Items using manual triggers no longer serve in Display & Video 360. This method will sunset on August 1, 2023. Read our [feature deprecation announcement](/display-video/api/deprecations#features.manual_triggers) for more information.
Request parameters:
advertiserId
- Required. The ID of the advertiser that the fetched
manual triggers belong to.
Value must have pattern ^\[^/\]+$
.
filter
- Allows filtering by manual trigger 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: * displayName
* state
Examples: * All
active manual triggers under an advertiser: state="ACTIVE"
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) * state
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 ListManualTriggers
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 ListManualTriggersResponse.
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<ListManualTriggersResponse> 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') +
'/manualTriggers';
final response_ = await _requester.request(
url_,
'GET',
queryParams: queryParams_,
);
return ListManualTriggersResponse.fromJson(
response_ as core.Map<core.String, core.dynamic>);
}