Method: advertisers.patch

AI-generated Key Takeaways

• Display & Video 360 API v2 has been sunset and this documentation details how to update an existing advertiser using the API.

• The API request utilizes an HTTP PATCH method with the advertiser ID as a path parameter and an update mask as a query parameter.

• The request body should contain an Advertiser object with the desired updates, while a successful response will return the updated Advertiser object.

• Authorization requires the https://www.googleapis.com/auth/display-video OAuth scope.

Display & Video 360 API v2 has sunset.

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

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

HTTP request

PATCH https://displayvideo.googleapis.com/v2/advertisers/{advertiser.advertiserId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiser.advertiserId	string (int64 format) Output only. The unique ID of the advertiser. 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 Advertiser.

Response body

If successful, the response body contains an instance of Advertiser.

Authorization scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.