Method: advertisers.channels.patch

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

  • The document describes how to update a channel using a PATCH request with the v3 API.

  • Updating a channel requires specifying path parameters like channel.channelId and either advertiserId or partnerId to identify the owner.

  • The request body requires an instance of Channel and a updateMask query parameter is required to specify which fields to update.

  • The response body, if successful, contains an instance of Channel and the operation requires the https://www.googleapis.com/auth/display-video OAuth scope.

Updates a channel. Returns the updated channel if successful.

HTTP request

PATCH https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/channels/{channel.channelId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
channel.channelId

string (int64 format)

Output only. The unique ID of the channel. Assigned by the system.
Union parameter owner. Required. Identifies which DV360 entity owns the channel. owner can be only one of the following:
advertiserId

string (int64 format)

The ID of the advertiser that owns the created channel.

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".
Union parameter owner. Required. Identifies which DV360 entity owns the channel. owner can be only one of the following:
partnerId

string (int64 format)

The ID of the partner that owns the created channel.

Request body

The request body contains an instance of Channel.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.