Method: advertisers.campaigns.patch

AI-generated Key Takeaways

• Display & Video 360 API v3 has sunset and users should use v4 instead.

• This documentation describes how to update an existing campaign using a PATCH request to a specified URL.

• The request uses path parameters for campaign.advertiserId and campaign.campaignId, and requires a updateMask query parameter.

• The request and response bodies contain a Campaign object.

• Authorization requires one of two specific OAuth scopes.

Display & Video 360 API v3 has sunset. Use v4 instead.

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• Try it!

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

HTTP request

PATCH https://displayvideo.googleapis.com/v3/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.