Method: advertisers.campaigns.patch

  • Display & Video 360 API v2 has sunset.

  • This page provides documentation for updating an existing campaign using the Display & Video 360 API v2.

  • The update is performed via a PATCH request to a specific URL including advertiser and campaign IDs.

  • Essential parameters for the request include campaign.advertiserId, campaign.campaignId, and a required updateMask.

  • A successful update returns the modified campaign object in the response body and requires specific OAuth scopes for authorization.

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.