activate method

Future<ManualTrigger> activate(ActivateManualTriggerRequest request, String advertiserId, String triggerId, { String? $fields, })

Activates a manual trigger.

Each activation of the manual trigger must be at least 5 minutes apart, otherwise an error will be returned. 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 - The metadata request object.

Request parameters:

advertiserId - Required. The ID of the advertiser that the manual trigger belongs. Value must have pattern ^\[^/\]+$.

triggerId - Required. The ID of the manual trigger to activate. Value must have pattern ^\[^/\]+$.

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

Completes with a ManualTrigger.

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<ManualTrigger> activate(
  ActivateManualTriggerRequest request,
  core.String advertiserId,
  core.String triggerId, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2/advertisers/' +
      core.Uri.encodeFull('$advertiserId') +
      '/manualTriggers/' +
      core.Uri.encodeFull('$triggerId') +
      ':activate';

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