delete method

Future<Empty> delete(String advertiserId, String campaignId, { String? $fields, })

Permanently deletes a campaign.

A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to ENTITY_STATUS_ARCHIVED, to be able to delete it. This method regularly experiences high latency. We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.

Request parameters:

advertiserId - The ID of the advertiser this campaign belongs to. Value must have pattern ^\[^/\]+$.

campaignId - The ID of the campaign we need to delete. Value must have pattern ^\[^/\]+$.

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

Completes with a Empty.

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<Empty> delete(
  core.String advertiserId,
  core.String campaignId, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v2/advertisers/' +
      core.Uri.encodeFull('$advertiserId') +
      '/campaigns/' +
      core.Uri.encodeFull('$campaignId');

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