Method: advertisers.campaigns.patch

  • Display & Video 360 API v1 has been sunset.

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

  • The request requires path parameters for the campaign and advertiser IDs, and a query parameter specifying the fields to update.

  • The request and response bodies contain a Campaign instance.

  • Specific OAuth scopes are required for authorization to perform this action.

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.