Method: advertisers.campaigns.patch

  • Display & Video 360 API v1 is sunsetted, and this documentation details updating existing campaigns using the v1 API.

  • The API request utilizes an HTTP PATCH method to https://displayvideo.googleapis.com/v1/advertisers/{campaign.advertiserId}/campaigns/{campaign.campaignId} and requires specifying the advertiser and campaign IDs.

  • To update a campaign, provide a request body containing the updated Campaign object and utilize the updateMask query parameter to specify the fields to be modified.

  • 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/v1/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.