Method: advertisers.campaigns.patch

  • The Display & Video 360 API v2 has been sunset and this documentation details updating existing campaigns using the API.

  • This endpoint uses a PATCH request to https://displayvideo.googleapis.com/v2/advertisers/{campaign.advertiserId}/campaigns/{campaign.campaignId} to update campaign details.

  • Developers need to specify the updateMask query parameter for indicating the fields to be updated and provide the campaign object in the request body.

  • Successful requests will return the updated campaign object in the response body.

  • Authorization requires specific OAuth scopes like https://www.googleapis.com/auth/display-video or https://www.googleapis.com/auth/display-video-mediaplanning.

Updates an existing campaign. Returns the updated campaign if successful.

HTTP request

PATCH https://displayvideo.googleapis.com/v2/advertisers/{campaign.advertiserId}/campaigns/{campaign.campaignId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
campaign.advertiserId

string (int64 format)

Output only. The unique ID of the advertiser the campaign belongs to.
campaign.campaignId

string (int64 format)

Output only. The unique ID of the campaign. Assigned by the system.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The mask to control which fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Campaign.

Response body

If successful, the response body contains an instance of Campaign.

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.