Method: advertisers.campaigns.patch

AI-generated Key Takeaways

• This document outlines how to update an existing campaign using an HTTP PATCH request.

• The update process requires specifying both the advertiser ID and the campaign ID as path parameters.

• A required updateMask query parameter is used to control which fields of the campaign are updated.

• The request and successful response bodies both contain an instance of a Campaign object.

• Authorization is required using specific OAuth scopes related to display video.

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