Method: advertisers.campaigns.delete

  • A campaign can be permanently deleted, but it cannot be recovered.

  • The campaign's entity status must be set to ENTITY_STATUS_ARCHIVED before it can be deleted.

  • This method may experience high latency, and increasing your default timeout is recommended.

  • The API call uses a DELETE request with advertiserId and campaignId as path parameters.

  • The request body is empty, and a successful response is an empty JSON object.

Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entityStatus to ENTITY_STATUS_ARCHIVED, to be able to delete it.

This method regularly experiences high latency. We recommend increasing your default timeout to avoid errors.

HTTP request

DELETE https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/campaigns/{campaignId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

The ID of the advertiser this campaign belongs to.
campaignId

string (int64 format)

The ID of the campaign we need to delete.

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/display-video
  • https://www.googleapis.com/auth/display-video-mediaplanning

For more information, see the OAuth 2.0 Overview.